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.

Sign up for GitHub

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

Jump to bottom

Remove docs from URL path #231

Closed
smythp opened this issue Aug 22, 2023 · 0 comments · Fixed by #232
Closed

Remove docs from URL path #231

smythp opened this issue Aug 22, 2023 · 0 comments · Fixed by #232
Labels
bug Something isn't working

Comments

@smythp
Copy link
Collaborator

smythp commented Aug 22, 2023

Description

As raised by @normal-coder in #229, the Hugo update added an additional "docs" level to the URL structure. While this is how the Doks theme is set up, it's semantically superfluous, considering that the entire site is a docs site.

Proposed Fix

I will remove docs from the content folder structure. Because Doks relies on this for templating, I will need to add front matter to all content indicating which template to use. I will also need to update the docs archetype so that any new pages use the new front matter format. Finally, I'll need to manually change how the left sidebar works, since it relies by default on the presence of the docs folder.

Benefits

The benefits will be a shorter and more semantic URL structure. Most inbound links will have been invalidated by the recent content reorg, but any that are the same will also be preserved.
@smythp smythp added the bug Something isn't working label Aug 22, 2023
smythp added a commit to smythp/sigstore-docs that referenced this issue Aug 22, 2023
@smythp
Removed docs from URL path
9644aea 
Removed the docs folder and moved all content up one level

Added necessary front matter to all content files, as Doks depended on
the docs folder to determine the template used

Updated archetype with correct front matter for furture file creation

Rewrote sidebar template to use new folder structure

Resolves sigstore#231

References sigstore#229

Signed-off-by: Patrick Smyth <[email protected]>
@smythp smythp mentioned this issue Aug 22, 2023
Merged
ltagliaferri pushed a commit that referenced this issue Aug 23, 2023
@smythp
Removed docs from URL path (#232)
162f92a 
* Removed docs from URL path

Removed the docs folder and moved all content up one level

Added necessary front matter to all content files, as Doks depended on
the docs folder to determine the template used

Updated archetype with correct front matter for furture file creation

Rewrote sidebar template to use new folder structure

Resolves #231

References #229

Signed-off-by: Patrick Smyth <[email protected]>

* Changed FlexSearch params to reflect new structure

Signed-off-by: Patrick Smyth <[email protected]>

---------

Signed-off-by: Patrick Smyth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Removed docs from URL path smythp/sigstore-docs
1 participant
@smythp