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

Documentation not linked to menu #1352

Closed
whikloj opened this issue Nov 19, 2019 · 4 comments
Closed

Documentation not linked to menu #1352

whikloj opened this issue Nov 19, 2019 · 4 comments
Milestone

Comments

@whikloj
Copy link
Member

whikloj commented Nov 19, 2019

Part of #1040

When serving mkdocs locally

> mkdocs serve

It lists files in the /docs directory that are not linked from the menu. These are

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - alpaca/alpaca-technical-stack.md
  - contributing/hacking-on-islandora.md
  - contributing/readme_template.md
  - islandora/drupal-bundle-configurations.md
  - migration/fedora-namespace-predicates.md
  - migration/islandora-namespace-predicates.md
  - migration/migration.md
  - mvp/mvp_doc.md
  - technical-documentation/checking-coding-standards.md
  - technical-documentation/drupal-project.md
  - technical-documentation/resizing_vm.md
  - technical-documentation/structure.md
  - user-documentation/access-control.md
  - user-documentation/derivatives.md
  - user-documentation/different_from_7x.md
  - user-documentation/fedora-rdf.md
  - user-documentation/getting-started-with-islandora-claw.md
  - user-documentation/glossary.md
  - user-documentation/intro-to-claw.md
  - user-documentation/intro-to-ld-for-islandora-8.md 

They need to be linked or could be deleted.

Additionally it warned about a missing file being referenced.

WARNING -  Documentation file 'user-documentation/context.md' contains a link to 'user-documentation/datastreams.md' which is not found in the documentation files. 
WARNING -  Documentation file 'user-documentation/user-intro.md' contains a link to 'user-documentation/datastreams.md' which is not found in the documentation files. 
@seth-shaw-unlv
Copy link
Contributor

Update: the current docs have a slightly different list:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - alpaca/alpaca-technical-stack.md
  - contributing/hacking-on-islandora.md
  - contributing/readme_template.md
  - islandora/drupal-bundle-configurations.md
  - migration/fedora-namespace-predicates.md
  - migration/islandora-namespace-predicates.md
  - migration/migration.md
  - mvp/mvp_doc.md
  - technical-documentation/checking-coding-standards.md
  - technical-documentation/drupal-project.md
  - technical-documentation/resizing_vm.md
  - technical-documentation/structure.md
  - user-documentation/access-control.md
  - user-documentation/derivatives.md
  - user-documentation/different_from_7x.md
  - user-documentation/fedora-rdf.md
  - user-documentation/getting-started-with-islandora-claw.md
  - user-documentation/glossary.md
  - user-documentation/intro-to-8.md
  - user-documentation/intro-to-ld-for-islandora-8.md
  - user-documentation/versioning.md 
WARNING -  Documentation file 'user-documentation/collections.md' contains a link to 'assets/collections_admin_content_button.png' which is not found in the documentation files.

@dannylamb dannylamb added this to the 1.1.0 milestone Jan 29, 2020
@manez
Copy link
Member

manez commented Feb 3, 2020

I'll work on this today

@manez
Copy link
Member

manez commented Feb 12, 2020

One more merge and this one is addressed 😄

@manez
Copy link
Member

manez commented Feb 12, 2020

resolved by #1419 and #1421

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

No branches or pull requests

4 participants