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

Decouple parent from page name #171

Open
TRSx80 opened this issue Jan 31, 2022 · 2 comments
Open

Decouple parent from page name #171

TRSx80 opened this issue Jan 31, 2022 · 2 comments
Labels

Comments

@TRSx80
Copy link
Member

TRSx80 commented Jan 31, 2022

Currently, each page follows a naming convention, like:

Parent-Topic-Name_Child-Topic-Name.md

  1. Is there something in mkdocs which requires this to function properly, or is this simply some arbitrary convention someone decided on at some point?

Because it seems to me that mkdocs.yaml is the correct place to link pages with their parents.

The problem is, we currently have a number of pages which I think no longer match their parent. For just a couple examples:

  • We claim to be a build system, but building is under Development (I think it should be under User Guide, if we are being consistent, or perhaps a new section).
  • FEL boot (and maybe others) should be moved to Archive / deprecated section
  • maybe others

But above specifics are not the point of this issue, just examples.

If pages were not coupled to their parents (in the file name) I think we can move them around in mkdocs.yaml to new parents whenever we want without breaking links.

Of course I will figure out some way to keep the old links alongside, so as not to break them. Which is another implementation detail to be decided after the main part of this topic (the numbered question, above).

@lanefu
Copy link
Member

lanefu commented Feb 1, 2022

It's a product of bad house keeping over time. Mkdocs supports relative links but was seldom leveraged.

File name convention is amiss from initial import and then an intention to dynamically generate the mkdocs.yml by file name. Although it worked it was abandoned.

@TRSx80
Copy link
Member Author

TRSx80 commented Feb 1, 2022

I guess I am thinking the ability to move children to different parents, without breaking existing links (should re-organization be necessary) is more valuable than dynamically generating one small file of yaml? Especially if we are not even doing that any longer?

If true, I can try and move forward first by figuring out how not to break the old (current) links. I vaguely recall something in mkdocs which does that, but it's been a while since I read it. I'm sure I can find it again though.

TRSx80 added a commit that referenced this issue Feb 1, 2022
Since we are not using it anyway.

This reduces local mkdocs re-generation from minutes to seconds.

It also prevents almost 10K lines of binary (document.pdf) from being
added to the docs repo with every PR.

See also: #171.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants