mgmt icon indicating copy to clipboard operation
mgmt copied to clipboard

quick-start-guide: fix broken URL

Open hades opened this issue 1 year ago • 1 comments

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!

hades avatar Sep 07 '24 08:09 hades

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...

purpleidea avatar Sep 07 '24 14:09 purpleidea

Thank you! I tried to push the latest version of the docs with the newest sphinx, but it didn't work. I think we'll probably deprecate this, but for now I'll leave this in case sphinx or future tools work correctly.

purpleidea avatar Feb 05 '25 14:02 purpleidea