You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/documentation_workflow.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,17 @@ tags:
9
9
# GitHub Workflow
10
10
11
11
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:
14
14
```shell
15
15
git checkout -b ISSUE-100
16
16
```
17
-
5. Copy this template to create a new piece of documentation:
17
+
4. Copy this template to create a new piece of documentation:
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:
23
23
```yaml hl_lines="7"
24
24
nav:
25
25
- Home: index.md
@@ -38,13 +38,13 @@ tags:
38
38
- Adding Demo Archipelago Digital Objects (ADOs) to your Repository: archipelago-deployment-democontent.md
39
39
...
40
40
```
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:
42
42
```shell
43
43
pip install mkdocs-material mike git+https://github.com/jldiaz/mkdocs-plugin-tags.git mkdocs-git-revision-date-localized-plugin mkdocs-glightbox
44
44
```
45
45
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.
46
46
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:
48
48
```shell
49
49
mike deploy 1.4.0
50
50
mike set-default 1.4.0
@@ -54,20 +54,20 @@ tags:
54
54
mike deploy ISSUE-129
55
55
mike set-default ISSUE-129
56
56
```
57
-
8. Start the web server:
57
+
9. Start the web server:
58
58
```shell
59
59
mike serve
60
60
```
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:
63
63
```shell
64
64
git add .
65
65
git commit -m "Create new docs with useful information."
66
66
git push origin ISSUE-100
67
67
```
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`.
69
69
70
-
12. Please tag `@alliomeria` when you are ready foryour contributed documentation to be reviewed. Our team will review and provide feedback, and let you know when your contributed documentation is merged. Thank youin advance for your time and efforts to create documentation for Archipelago's community!
70
+
13. Please tag `@alliomeria` when you are ready foryour contributed documentation to be reviewed. Our team will review and provide feedback, and let you know when your contributed documentation is merged. Thank youin advance for your time and efforts to create documentation for Archipelago's community!
0 commit comments