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

Removed docs from URL path #232

Merged
merged 2 commits into from
Aug 23, 2023

Conversation

smythp
Copy link
Collaborator

@smythp smythp commented Aug 22, 2023

Summary

As raised in #229 and #231, an additional "docs" level was added to the docs site URL structure. This is largely superfluous. Our template, Doks, assumes the presence of a first-level section like "docs" in a number of places, and this PR makes changes related to adapting the site to a structure that does not have a single first-level section such as "docs" .

Notes

This update moves all content up one level, and is likely to conflict with other PRs. It would be best to merge quickly.

Changes

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 future file creation

Rewrote sidebar template to use new folder structure

Resolves #231

References #229

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]>
@netlify
Copy link

netlify bot commented Aug 22, 2023

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit 44349eb
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/64e5240a9067b200085d8f0b
😎 Deploy Preview https://deploy-preview-232--docssigstore.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ltagliaferri ltagliaferri merged commit 162f92a into sigstore:main Aug 23, 2023
5 checks passed
normal-coder added a commit to normal-coder/Sigstore-Docs that referenced this pull request Aug 25, 2023
* main:
  ci(github action): add Markdown linter check support for main branch (sigstore#227)
  Redirects now appears in public (sigstore#234)
  add 'cosign sign-blob'in the mTLS TSA section (sigstore#239)
  Changed 404 text, restored i18n (sigstore#238)
  Restored Netlify redirects file (sigstore#233)
  Removed docs from URL path (sigstore#232)
  Corrected the confusion of steps in the document due to formatting (sigstore#220)
  Added anchor text to link to releases page (sigstore#223)
normal-coder added a commit to normal-coder/Sigstore-Docs that referenced this pull request Aug 25, 2023
* main:
  ci(github action): add Markdown linter check support for main branch (sigstore#227)
  Redirects now appears in public (sigstore#234)
  add 'cosign sign-blob'in the mTLS TSA section (sigstore#239)
  Changed 404 text, restored i18n (sigstore#238)
  Restored Netlify redirects file (sigstore#233)
  Removed docs from URL path (sigstore#232)
  Corrected the confusion of steps in the document due to formatting (sigstore#220)
  Added anchor text to link to releases page (sigstore#223)
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

Successfully merging this pull request may close these issues.

Remove docs from URL path
2 participants