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

quick-start-guide: fix broken URL #770

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

hades
Copy link

@hades hades commented Sep 7, 2024

Replace a relative directory path with an absolute URL to Github, so that the readthedocs site[1] renders it correctly.

[1] https://mgmt.readthedocs.io/en/stable/quick-start-guide.html#examples

Tips:

  • please read the style guide before submitting your patch:
    docs/style-guide.md

  • commit message titles must be in the form:

topic: Capitalized message with no trailing period

or:

topic, topic2: Capitalized message with no trailing period

  • golang code must be formatted according to the standard, please run:
make gofmt		# formats the entire project correctly

or format a single golang file correctly:

gofmt -w yourcode.go
  • please rebase your patch against current git master:
git checkout master
git pull origin master
git checkout your-feature
git rebase master
git push your-remote your-feature
hub pull-request	# or submit with the github web ui
  • after a patch review, please ping @purpleidea so we know to re-review:
# make changes based on reviews...
git add -p		# add new changes
git commit --amend	# combine with existing commit
git push your-remote your-feature -f
# now ping @purpleidea in the github PR since it doesn't notify us automatically

Thanks for contributing to mgmt and welcome to the team!

Replace a relative directory path with an absolute URL to
Github, so that the readthedocs site[1] renders it correctly.

[1] https://mgmt.readthedocs.io/en/stable/quick-start-guide.html#examples
@purpleidea
Copy link
Owner

Oh interesting! Actually the bigger issue is the read the docs site is totally stale. Not sure how that was setup and if it's even useful anymore...

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.

2 participants