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

The admin section of the docs is missing #3152

Closed
geekysquirrel opened this issue Oct 19, 2020 · 4 comments · Fixed by #3156
Closed

The admin section of the docs is missing #3152

geekysquirrel opened this issue Oct 19, 2020 · 4 comments · Fixed by #3156
Assignees
Labels
bug Something isn't working docs Documentation issues

Comments

@geekysquirrel
Copy link

Describe the bug
https://flowkit.xyz/install/administrator returns a 404.

Version
c4dc74f

To Reproduce
Visit https://flowkit.xyz/install/administrator

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
Screenshot 2020-10-19 at 11 17 19

@geekysquirrel geekysquirrel added bug Something isn't working docs Documentation issues labels Oct 19, 2020
@jc-harrison
Copy link
Member

Oops! The correct URL is https://flowkit.xyz/administrator. Looks like there's a broken relative link somewhere.

@geekysquirrel
Copy link
Author

That would be in the "installation requirements" section of https://flowkit.xyz/install/

@geekysquirrel
Copy link
Author

Looking at the code it should work, as the links are relative from the install.md to the admin/developer sections. However, the deployed docs seem to have an extra directory "install" in between, which breaks the links. Not sure where this should be changed.

@jc-harrison
Copy link
Member

I think the issue here is that when Mkdocs builds the docs, it will convert '{source}/install.md' to '{root}/install/index.html', so then a relative link from install.md to 'administrator' will end up pointing to '{root}/install/administrator/', and the required relative link here should actually be '../administrator'.

When linking from one source file to another source file, Mkdocs is smart enough to change the link in the output file appropriately. The problem here is that the link just points to a directory ('administrator'), rather than an actual source file ('administrator/index.md'), so Mkdocs leaves it unchanged when building the docs. So changin the link from 'administrator' to 'administrator/index.md' in install.md should fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Documentation issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants