Skip to content

Commit 2279350

Browse files
authored
Update documentation_workflow.md
1 parent d3d90df commit 2279350

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/documentation_workflow.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ tags:
99
# GitHub Workflow
1010

1111
1. First, either open a new Issue in the [Archipelago Documentation Github Repo](https://github.com/esmero/archipelago-documentation) describing the new documentation you would like to contribute, or reply to an existing Issue that you would like to address. Tag `@alliomeria` to request feedback. Since our team is consistently working on new and updating existing documentation, please wait for review and guidance before proceeding with creating the new documentation you described in your new Issue or comments on an existing documentation Issue.
12-
3. [Fork the documentation repo](https://github.com/esmero/archipelago-documentation). If you're not familiar with forking [see this guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
13-
4. Create an issue branch in your forked repo. For example, if the issue you're resolving is ISSUE-100:
12+
2. [Fork the documentation repo](https://github.com/esmero/archipelago-documentation). If you're not familiar with forking [see this guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
13+
3. Create an issue branch in your forked repo. For example, if the issue you're resolving is ISSUE-100:
1414
```shell
1515
git checkout -b ISSUE-100
1616
```
17-
5. Copy this template to create a new piece of documentation:
17+
4. Copy this template to create a new piece of documentation:
1818
```shell
1919
cp docs/documentation_template.md docs/new_documentation.md
2020
```
21-
6. Make your changes to the copied markdown file.
22-
5. If this is new documentation add it to the `nav` section of the `mkdocs.yml` configuration file at the root of the repo. For example:
21+
5. Make your changes to the copied markdown file.
22+
6. If this is new documentation add it to the `nav` section of the `mkdocs.yml` configuration file at the root of the repo. For example:
2323
```yaml hl_lines="7"
2424
nav:
2525
- Home: index.md
@@ -38,13 +38,13 @@ tags:
3838
- Adding Demo Archipelago Digital Objects (ADOs) to your Repository: archipelago-deployment-democontent.md
3939
...
4040
```
41-
6. To view the changes locally, first install the Python libraries using the Python package manager pip:
41+
7. To view the changes locally, first install the Python libraries using the Python package manager pip:
4242
```shell
4343
pip install mkdocs-material mike git+https://github.com/jldiaz/mkdocs-plugin-tags.git mkdocs-git-revision-date-localized-plugin mkdocs-glightbox
4444
```
4545
You may need to install Python on your machine. [Download Python](https://www.python.org/downloads/) or use your favorite operating system package manager such as Homebrew.
4646

47-
7. Now you can build the site locally, e.g. for the documentation using the 1.4.0 branch:
47+
8. Now you can build the site locally, e.g. for the documentation using the 1.4.0 branch:
4848
```shell
4949
mike deploy 1.4.0
5050
mike set-default 1.4.0
@@ -54,20 +54,20 @@ tags:
5454
mike deploy ISSUE-129
5555
mike set-default ISSUE-129
5656
```
57-
8. Start the web server:
57+
9. Start the web server:
5858
```shell
5959
mike serve
6060
```
61-
9. Check the results in your browser by going to: <http://localhost:8000>
62-
10. If everything looks good, you can push to your forked repo issue branch:
61+
10. Check the results in your browser by going to: <http://localhost:8000>
62+
11. If everything looks good, you can push to your forked repo issue branch:
6363
```shell
6464
git add .
6565
git commit -m "Create new docs with useful information."
6666
git push origin ISSUE-100
6767
```
68-
11. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and link to the issue by tagging it, e.g. `Resolves #100`.
68+
12. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and link to the issue by tagging it, e.g. `Resolves #100`.
6969

70-
12. Please tag `@alliomeria` when you are ready for your contributed documentation to be reviewed. Our team will review and provide feedback, and let you know when your contributed documentation is merged. Thank you in advance for your time and efforts to create documentation for Archipelago's community!
70+
13. Please tag `@alliomeria` when you are ready for your contributed documentation to be reviewed. Our team will review and provide feedback, and let you know when your contributed documentation is merged. Thank you in advance for your time and efforts to create documentation for Archipelago's community!
7171
7272
___
7373

0 commit comments

Comments
 (0)