Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial changes to documentation menu structure #1682

Merged
merged 7 commits into from
Nov 13, 2020
Merged

initial changes to documentation menu structure #1682

merged 7 commits into from
Nov 13, 2020

Conversation

eldonquijote
Copy link
Contributor

@eldonquijote eldonquijote commented Nov 6, 2020

Purpose / why

Evolution of Islandora documentation structure, facilitate gap identification

What changes were made?

  • changed documentation structure by moving and renaming menu items
  • added 'permalink' feature to mkdocs config to add link anchors to headings
  • added placeholder page so we are able to add menu entries that are still awaiting documentation to be written

Verification

check for unclear page titles, add placeholder entries

Interested Parties

@manez @rosiel @dannylamb Jeff?


Checklist

Pull-request reviewer should ensure the following

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@manez
Copy link
Member

manez commented Nov 9, 2020

Er.. I tried to make a pull request against your branch but instead I seem to have pushed the change. Please feel free to revert if you don't like the suggestion to add the DIG to the placeholder page. It was meant as just a suggestion 😅

I did a test build with these changes and everything looks good! Since I now have a commit on this one, we'll need some one else to merge.

Renamed menu entry "Add a New User" to "Create and Manage User Accounts" to be in line with Melissa's earlier PR
@manez
Copy link
Member

manez commented Nov 9, 2020

Tagging @jrubin6 since he is name-dropped in the PR too :)

@@ -116,7 +201,8 @@ nav:
- 'Resizing a VM': 'technical-documentation/resizing_vm.md'
- 'Checking Coding Standards': 'technical-documentation/checking-coding-standards.md'
- 'Contributing Workflow': 'contributing/contributing-workflow.md'
- 'Editing Documentation': 'contributing/editing-docs.md'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is @manez 's new tutorial for people who haven't made a PR before, can we keep it in?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good eye, I must have lost that one with all the reshuffling. I'll push an update in a bit

Copy link
Member

@rosiel rosiel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! @Islandora/8-x-committers Can someone swoop in for the merge, since I technically am on the commit list for this PR?

@elizoller elizoller merged commit 9c6ef9f into Islandora:main Nov 13, 2020
@eldonquijote eldonquijote deleted the documentation-structure-evolution branch November 17, 2020 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants