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.

Sign up for GitHub

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

HDDS-11972. Update contributing guide for migrating content from the current website #119

Merged
merged 2 commits into from
Dec 20, 2024
Merged

HDDS-11972. Update contributing guide for migrating content from the current website #119

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49e8e91
Update PR template and contributing guide
errose28 Dec 20, 2024
6d2c115
Revert PR template change, it must be cherry-picked from master
errose28 Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ This document summarizes the contribution process.

Please follow the same [Jira guidelines](https://github.com/apache/ozone/blob/master/CONTRIBUTING.md#jira-guideline) as the main Ozone project when filing improvements or issues for the website. Website Jira issues are also under the HDDS project, but can be tagged with `website` and `documentation` to distinguish them from changes to Ozone itself.

## Migrating Content From the Current Website to the New Website

If you are migrating a page from the old website to the new website, please follow these steps:

1. Verify that the content of the original page is clear and accurate.
2. If there are issues with the original page, raise a PR with your fixes to the [current Ozone website](https://github.com/apache/ozone/tree/master/hadoop-hdds/docs) to fix the page first.
3. Once the page is merged into the current website, migrate it to the new website and raise a PR.
- Pages being brought in from the current website may be enhanced with [additional markdown functionality](#page-format) supported by the new website.

## Modifying the Website

The Apache Ozone Website uses [Docusaurus](https://docusaurus.io/) as a static site generator. Most simple updates to the website can be done with little knowledge of Docusaurus, but for more complex modifications to the website or a better understanding of how it is built, see the Docusaurus [documentation](https://docusaurus.io/docs) and [API](https://docusaurus.io/docs/cli).
Expand Down
Loading