-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Document the procedure for forking the dev docs
- Loading branch information
1 parent
544444a
commit fa11172
Showing
2 changed files
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Managing Moodle version documentation | ||
sidebar_label: Moodle versions | ||
tags: | ||
- documentation | ||
- forking | ||
- versions | ||
--- | ||
|
||
We generate version-specific documentation and maintain this for each supported version of Moodle. | ||
|
||
When a new version of Moodle is released, the documentation is 'forked'. | ||
|
||
When a version of Moodle goes out of support, its developer documentation is archived. | ||
|
||
Further information about this functionality is available in the [Docusaurus documentation on the topic](https://docusaurus.io/docs/versioning). | ||
|
||
## Creating a new version of the docs | ||
|
||
Typically this task is performed by the Integration team using the following steps: | ||
|
||
1. Ensure that all pending appropriate merge requests have been merged | ||
1. Ensure that your local branch is up-to-date | ||
1. Run the docusaurus version command: | ||
|
||
```bash | ||
yarn docusaurus docs:version [version] | ||
``` | ||
|
||
1. Commit the initial changes ([Example from Moodle 4.4](https://github.com/moodle/devdocs/commit/XXX)) | ||
1. Open `versioned_docs/version-[version]/intro.md` in your editor | ||
1. Uncomment and update the link to the release notes for this version | ||
1. Open `docs/devupdate.md` in your editor | ||
1. Clear the content of this file and update the version numbers | ||
1. Open `nextVersion.js` in your editor | ||
1. Update the values for `nextVersion` and `nextLTSVersion` | ||
1. Commit these changes ([Example from Moodle 4.4](https://github.com/moodle/devdocs/commit/XXY)) | ||
1. Create a pull request ([Example from Moodle 4.4](https://github.com/moodle/devdocs/pull/1006)) | ||
|
||
## Archiving a version of the docs | ||
|
||
This procedure has not yet been completed and documentation will be created when we do so. |