rdblue commented on a change in pull request #59: URL: https://github.com/apache/iceberg-docs/pull/59#discussion_r813088454
########## File path: README.md ########## @@ -31,20 +31,30 @@ 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`. + +`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 accross all versions, such as the Iceberg format specification. + +`apache/iceberg-docs` +- The `docs/content/docs` folder is a mirror of the `docs` folder in the iceberg repo and the target when copying the docs over during a 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 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. +Contents under `docs` are copied to `./docs/content/docs` here, Review comment: Are these docs used in the main site build? If not, can we make this an empty directory except for in release branches? That is, I think the current flow is this: 1. Copy all docs from the iceberg repo into `docs/contents/docs` and commit to main 2. Create a branch from main named for the release version 3. Update the latest branch head to point to the release branch Instead, could we do this? 1. Create a branch from main named for the release version 2. Copy the iceberg repo docs into the release branch under `docs/contents/docs` 3. Update the latest branch head to point to the release branch That would mean that `main` never has a copy of versioned docs and we can say that you can edit a markdown file wherever you find it. And we could have a more specific README in the `docs/contents/docs` folder. -- 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]
