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

Determine if files mkdocs thinks are "unlinked" need attention #2068

Open
ysuarez opened this issue Mar 25, 2022 · 2 comments
Open

Determine if files mkdocs thinks are "unlinked" need attention #2068

ysuarez opened this issue Mar 25, 2022 · 2 comments
Assignees
Labels
Type: documentation provides documentation or asks for documentation.

Comments

@ysuarez
Copy link
Contributor

ysuarez commented Mar 25, 2022

Recently when building the docs locally the mkdocs software listed these following files are not linked in the navigation section.

<snip>
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - placeholder.md
  - contributing/readme_template.md
  - installation/docker-download.md
  - tutorials/switch_homepage_to_twig.md
  - user-documentation/recipes/alexa_search.md 
<snip>

@eldonquijote made the following early analysis of these files.

- user-documentation/recipes/alexa_search.md is linked from the page "Extending Islandora" (aka cookbook)
- placeholder.md is practically empty
- installation/docker-download.md is empty

- tutorials/switch_homepage_to_twig.md could be linked from the Cookbook as well, although I'm not sure whether the described steps are optional, or should actually be best practice if Twig is the default templating mechanism in D8..?
- contributing/readme_template.md - unclear where that should be linked from

I am wondering if we should run a grep on some of these files to see if they are being referenced somewhere? Should some of them be deleted, ignored, or linked somewhere?

@ysuarez ysuarez added the Type: documentation provides documentation or asks for documentation. label Mar 25, 2022
@inikolaidis
Copy link
Contributor

Could the contributing/readme_template.md be linked to from the section contributing/CONTRIBUTING/#contribute-code ?

@ysuarez ysuarez changed the title Determine if files mkdocs thinks are "unliked" need attention Determine if files mkdocs thinks are "unlinked" need attention Mar 30, 2022
@ysuarez ysuarez self-assigned this Mar 30, 2022
@eldonquijote
Copy link
Contributor

Agree with @inikolaidis on linking contributing/readme_template.md from the section contributing/CONTRIBUTING/#contribute-code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: documentation provides documentation or asks for documentation.
Projects
Development

No branches or pull requests

3 participants