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

fix(gendocs): Remove old link prefixes #1230

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from

Conversation

craciunoiuc
Copy link
Member

Prerequisite checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Ran make fmt on your commit series before opening this PR;
  • Updated relevant documentation.

Description of changes

@nderjung this might not be universally correct, but keep it in mind when deploying docs. After an initial scan it looks fine.

@nderjung
Copy link
Member

nderjung commented Feb 12, 2024

Can you please add a CLI arg that provides the user the option to specify the URL prefix? This allows the docs to be placed in different places whilst simultaneously preventing this type of fix in the future.

The flag should be named -url-prefix and should be propagated as a GNU Make variable, DOCS_URL_PREFIX, for the gendocs target. The default value should be set to /docs/cli/reference/.

@craciunoiuc craciunoiuc marked this pull request as draft July 5, 2024 05:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🧊 Icebox
Development

Successfully merging this pull request may close these issues.

2 participants