samredai commented on a change in pull request #35: URL: https://github.com/apache/iceberg-docs/pull/35#discussion_r799903850
########## File path: README.md ########## @@ -26,15 +26,59 @@ It's built with [Hugo](https://gohugo.io/) and hosted at https://iceberg.apache. The Iceberg documentation site is actually constructed from two hugo sites. The first, is the landing page. The second site, is the documentation site which contains the full Iceberg documentation, including the javadoc. The landing page and -documentation sites are completely self-contained in the `./landing-page` and `./docs` directories, respectively. +documentation sites are completely self-contained in the `./landing-page` and `./docs` directories, respectively. The Javadocs are in the `./javadoc` directory. -# Landing Page Deployment +# How to Contribute + +## Submitting Pull Requests + +All pull requests to update the latest documentations should be submitted to the [Iceberg repository](https://github.com/apache/iceberg). +When Iceberg publishes a new release, the release manager copies all the documentation to this repository and cut a new version branch. + +Changes to the landing page 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. + +## Reporting Issues + +All issues related to documentation and website should still be submitted to the [Iceberg repository](https://github.com/apache/iceberg). + +## Running Locally + +To start the landing page site locally, clone this repository and run the following. +```shell +git clone [email protected]:apache/iceberg-docs.git +cd landing-page && hugo serve +``` + +To start the documentation site locally, clone this repository and run the following. +```shell +git clone [email protected]:apache/iceberg-docs.git +git submodule update --init +cd docs && hugo serve +``` + +## Viewing Latest Website + +If you would like to see how the latest website looks based on the documentation in the Iceberg repository, you can copy docs to this repository by: Review comment: Once this PR and PR #27 is merged, I'll go ahead and open the PR against `apache/iceberg` to add those `documentation/common` and `documentation/versioned` directories. -- 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]
