-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Process for authoritative 'getting started' guides #472
Comments
What format would these docs be in? |
Markdown. The only real requirement is that they have a block at the beginning like so, with appropriate frontmatter (see https://gohugo.io/content-management/front-matter/) -
They can also use any other features available to the docs site, such as tabs by calling the appropriate blocks (as seen in the Erlang/Elixir docs) -
|
How should links be handled? |
Absolute links should be fine irregardless. Relative links should also be fine, as Hugo defaults to not canonifying relative links, and it tends to be kinda smart about it.. for example, in The only thing I can see tripping people up is creating relative links to content outside of the |
I'm going through and making PR's mirroring the website docs to SIG repos today. |
Add opentelemetry.io docs Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/swift).
Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector).
Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector).
Superseded by #730, but I'll keep this open for now since I'm still updating the table with statuses. |
Status table is complete. Closing in favor #730. |
Per comments in maintainers meeting, SIG maintainers desire a more clear process for handling website 'getting started' docs updates. Suggested process is this -
website_docs
directory at the root of their repo../content/en/docs/java
in theirwebsite_docs
directory, and so forth.website_docs
directory applied to the appropriate location in theopentelemetry.io
repository.cc @open-telemetry/docs-approvers @open-telemetry/docs-maintainers for discussion before 3/8 Maintainer's Meeting.
Edits (@chalin)
Renamed
website-docs
towebsite_docs
in the text above, since that is what seems to be used across the language repos.Here is a list of the code repos with an indication of their status (as of 2021/09/25):
website_docs
folderdocs-update
GH Action☑️☑️☑️☑️*☑️*☑️✖️☑️*☑️*☑️☑️*The repo link, is the link to the PR that created the
website_docs
folder.The text was updated successfully, but these errors were encountered: