Add CONTRIBUTING.md to outline the documentation generation pipeline #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Jeremy Hinegardner <[email protected]>
st0012
force-pushed
the
document-documentation-generation-pipeline
branch
from
c6e5507 to
2cad8ca
Compare
martinemde
reviewed
Nov 15, 2024
|
|
||
| - A scheduled [GitHub Action](https://github.com/ruby/actions/blob/master/.github/workflows/docs.yml) generates the documentation for all [actively maintained Ruby versions](https://www.ruby-lang.org/en/downloads/branches/) plus the master branch. Each documentation set is generated using the version of RDoc bundled with that specific Ruby version. | ||
| - *Example:* For [Ruby 3.3](https://docs.ruby-lang.org/en/3.3/), the documentation is generated with RDoc 6.6.3.1. | ||
| - The generated docs are uploaded as `ruby-docs-en-<version>.tar.xz` to the `ftp.r-l.o/pub/ruby/doc/` S3 bucket. |
There was a problem hiding this comment.
It took me a moment to understand the r-l.o abbreviation. Is this actually the bucket name or a shortcut in this doc?
There was a problem hiding this comment.
It's the actual name used in the github action (location).
|
@hsbt can you help me check if my understanding on this is correct? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The pipeline involves multiple repositories and services and the interactions between them are not easily understandable. So I think it'd be very helpful to have it documented.
Big thanks to @copiousfreetime for helping me piecing this together.