samredai commented on a change in pull request #59: URL: https://github.com/apache/iceberg-docs/pull/59#discussion_r814050959
########## File path: README.md ########## @@ -31,25 +31,40 @@ The Javadocs are in the `./javadoc` directory. ## Relationship to the Iceberg Repository -The `documentation` folder in the [Iceberg repository](https://github.com/apache/iceberg) contains all the markdown docs used by the website. -The `common` subfolder contains contents used by the landing page. -The `versioned` subfolder contains the contents different for each version. +All markdown pages that are part of a versioned released are maintained in the iceberg repository. All pages common across all version +releases are kept here in the iceberg-docs repo. A few exceptions are the markdown files that can be found in the `format` folder in +the iceberg repository and contains markdown files that are copied to `./landing-page/content/common/format`. -During each new release, the release manager copies contents from the Iceberg repository to this docs repository and cuts a new version branch. -Contents under `common` are copied to `./landing-page/contents/common` here, -and contents under `versioned` are copied to `./docs/contents/docs` here. -Javadocs generated from the release are copied to the `javadoc` directory. +`apache/iceberg` +- The `docs` folder in the [Iceberg repository](https://github.com/apache/iceberg) contains all the markdown docs used by the **versioned** docs site. +- The `format` folder contains some items that are common across all versions, such as the Iceberg format specification. + +`apache/iceberg-docs` +- The `docs/content/docs` folder is the target folder when copying the docs over during a version release +- The `landing-page/content/common` folder is where you can find the common markdown files shared across all versions + +During each new release, the release manager will: +1. Create a branch in this repo from main named for the release version +2. Copy the contents under `docs` in the iceberg repo to `./docs/content/docs` in the release branch +3. Copy the contents under `format` in the iceberg repo to `./landing-page/content/common/format` in the release branch +4. Generate the javadocs for the release and copy them into the `javadoc` directory in the release branch +5. Update the latest branch HEAD to point to the release branch HEAD # How to Contribute ## Submitting Pull Requests -Changes to the markdown contents should be submitted directly in the Iceberg repository. +Changes to the markdown contents for **version** specific pages should be submitted directly in the Iceberg repository. + +Changes to the markdown contents for common pages should be submitted to this repository against the `main` branch. Changes to the website appearance (e.g. HTML, CSS changes) should be submitted to this repository against the `main` branch. Changes to the documentation of old Iceberg versions should be submitted to this repository against the specific version branch. +In summary, you can open a PR against where you find the related markdown file. There are no duplicate markdown files between the +`master` branch in the iceberg repo and the `main` branch in the iceberg-docs repo. Review comment: Ah right, we can't avoid not including it here in the `main` branch since that's how the landing-page site gets deployed. Ok I'll try to highlight that super clearly as an exception to the rule. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
