Update contributing docs regarding backend documentation #8943
Conversation
CONTRIBUTING.md
Outdated
| After your changes has been merged, you can verify them on | ||
| [tip.rclone.org](https://tip.rclone.org). They will be included on the main | ||
| [rclone.org](https://rclone.org) site once they have been included in a release. |
There was a problem hiding this comment.
Can we be more specific regarding when the tip.rclone.org will be updated with changes after a PR has been merged?
There was a problem hiding this comment.
I looked at the crontab - tip.rclone.org is updated at 06:00 UTC daily. However the webserver is refreshed only hourly so it is likely not visible until 07:00 UTC.
How about
tip.rclone.org is updated daily with the current state of the master branch at 07:00 UTC
CONTRIBUTING.md
Outdated
| After your changes has been merged, you can verify them on | ||
| [tip.rclone.org](https://tip.rclone.org). They will be included on the main | ||
| [rclone.org](https://rclone.org) site once they have been included in a release. |
There was a problem hiding this comment.
I looked at the crontab - tip.rclone.org is updated at 06:00 UTC daily. However the webserver is refreshed only hourly so it is likely not visible until 07:00 UTC.
How about
tip.rclone.org is updated daily with the current state of the master branch at 07:00 UTC
albertony
force-pushed
the
contributing-docs
branch
from
b4b8266 to
3b68a0b
Compare
|
Perfect. Thanks for checking the tip.rclone.org details! |
2 participants
What is the purpose of this change?
In light of recent, and ongoing, cleanup and linting of Markdown documentation, I have extended the contributing guide a bit. Most important is an explanation of the
make backenddocs, which can be run to verify the resulting Markdown locally, but make it clear that it updates markdown files which should not be committed afterwards.Was the change discussed in an issue or in the forum before?
Checklist