We have an empty space now for AM3 configuration documentation.
https://access-nri.github.io/access-am3-configs/
So there's (at most) two steps to adding content, we describe two different methods, the first method only allows one to edit the landing page.
Getting involved in contributing
- create sub-issues of this issue to sub-divide creation of content (
create sub-issue button below this post) -- give issue a title of the section/pages you are working on;
- label sub-issue with "documentation";
- people self-assign into a sub-issue to do the task;
- author of content nominates reviewers upon completion.
Method 1 (takes one step but only allows one to edit existing pages)
If you just want to edit an existing page, then go here, click on the pencil twice and you can edit that page. Then follow the steps here.
Method 2 (takes two steps but you can add new pages)
If you want add a new page, then you want to add another markdown file in the folder:
https://github.com/ACCESS-NRI/access-am3-configs/tree/main/documentation/docs/pages
And then also tell the doc system that it needs to include the new page by adding a line here:
[Link to be confirmed after initial docs merge]
Note you'll need to add a pages to the path, you can see examples [here](Link to be confirmed after initial docs merge).
In the above workflows, we suggest making commits to a branch and then opening a pull request. Once a pull request is open it is possible to view a website-rendered version of the whole new website through a "PR-preview", a link will be given by the GitHub Actions inside the pull request. Typically this is of the form:
https://access-nri.github.io/access-am3-configs/pr-preview-#PR-number
Once changes are merged into the main branch, it should update the build of the docs here.
Feel free to ask questions in this thread if any aspect of this workflow is unclear.
--
Wondering what a configuration documentation is for? Have a look at what's been done for OM3 here.
--
We have an empty space now for AM3 configuration documentation.
https://access-nri.github.io/access-am3-configs/
So there's (at most) two steps to adding content, we describe two different methods, the first method only allows one to edit the landing page.
Getting involved in contributing
create sub-issuebutton below this post) -- give issue a title of the section/pages you are working on;Method 1 (takes one step but only allows one to edit existing pages)
If you just want to edit an existing page, then go here, click on the pencil twice and you can edit that page. Then follow the steps here.
Method 2 (takes two steps but you can add new pages)
If you want add a new page, then you want to add another markdown file in the folder:
https://github.com/ACCESS-NRI/access-am3-configs/tree/main/documentation/docs/pages
And then also tell the doc system that it needs to include the new page by adding a line here:
[Link to be confirmed after initial docs merge]
Note you'll need to add a
pagesto the path, you can see examples [here](Link to be confirmed after initial docs merge).In the above workflows, we suggest making commits to a branch and then opening a pull request. Once a pull request is open it is possible to view a website-rendered version of the whole new website through a "PR-preview", a link will be given by the GitHub Actions inside the pull request. Typically this is of the form:
https://access-nri.github.io/access-am3-configs/pr-preview-#PR-number
Once changes are merged into the main branch, it should update the build of the docs here.
Feel free to ask questions in this thread if any aspect of this workflow is unclear.
--
Wondering what a configuration documentation is for? Have a look at what's been done for OM3 here.
--