[iceberg-docs] branch main updated: Add contribution guidelines (#35)

[bl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

blue pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-docs.git


The following commit(s) were added to refs/heads/main by this push:
     new 8a53e51  Add contribution guidelines (#35)
8a53e51 is described below

commit 8a53e513ec24245d077b028db844410bd57e038c
Author: Jack Ye <yz...@amazon.com>
AuthorDate: Sun Feb 6 10:21:27 2022 -0800

    Add contribution guidelines (#35)
---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 65 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index eef928b..a663605 100644
--- a/README.md
+++ b/README.md
@@ -27,14 +27,73 @@ 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.
+The Javadocs are in the `./javadoc` directory.
 
-# Landing Page Deployment
+## 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.
+
+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.
+
+# How to Contribute
+
+## Submitting Pull Requests
+
+Changes to the markdown contents should be submitted directly in the Iceberg repository.
+
+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.
+
+## Reporting Issues
+
+All issues related to the doc website should still be submitted to the [Iceberg repository](https://github.com/apache/iceberg).
+The GitHub Issues feature of this repository is disabled.
+
+## Running Locally
+
+Clone this repository to run the website locally:
+```shell
+git clone git@github.com:apache/iceberg-docs.git
+cd iceberg-docs
+```
+
+To start the landing page site locally, run:
+```shell
+cd landing-page && hugo serve
+```
+
+To start the documentation site locally, run:
+```shell
+cd docs && hugo serve
+```
+
+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:
+```shell
+rm -rf docs/content/docs
+rm -rf landing-page/content/common
+cp -r <path to iceberg repo>/documentation/versioned docs/content/docs
+cp -r <path to iceberg repo>/documentation/common docs/content/common
+```
+
+## Scanning For Broken Links
+
+If you'd like to scan for broken links, one available tool is linkcheck that can be found [here](https://github.com/filiph/linkcheck).
+
+# How the Website is Deployed
+
+## Landing Page Deployment
 
 The landing page site is automatically deployed to the root of the `asf-site` branch by the `deploy-landing-page`
 job in the [deployment workflow](./.github/workflows/deploy.yml). There is only a single version of the landing
 page site, and the `deploy-landing-page` job only runs on commits to the `main` branch.
 
-# Docs Deployment
+## Docs Deployment
 
 The docs site is automatically deployed to the `docs` directory in the asf-site branch, into a sub-directory
 named after the branch where the commit occured. This is performed by the `deploy-docs` job in the
@@ -45,11 +104,11 @@ yet exist in the `asf-site` branch, it will be created.
 Additionally, the contents of the `javadoc` directory is deployed to a `javadoc/<branch_name>` directory in
 the `asf-site` branch.
 
-#### Latest Docs
+### Latest Docs
 In [./docs/redirect/index.html](./docs/redirect/index.html), a redirect meta tag exists to forward `/docs` 
 and `/latest` to `/docs/latest`.
 
-# `asf-site` Branch Structure
+## `asf-site` Branch Structure
 
 The `asf-site` branch structure is the following:
 ```
@@ -75,29 +134,10 @@ in the `asf-site` branch's `javadoc` directory.
 A `main` branch commit deploys the landing page site **only** and overwrites the landing page site at
 the root of the `asf-site` branch.
 
-# Redirects
+## Redirects
 
 Redirects within one of the two sites can easily be done using the `aliases` keyword in the YAML Front Matter.
 You can read more about this Hugo URL Management feature [here](https://gohugo.io/content-management/urls/#yaml-front-matter).
 
 For root level redirects that are outside of both sites, the `./redirects` directory contains pages with redirect `meta` tags.
-These are all deployed at the root level of the `asf-site` branch by the `Deploy redirects` step in the [deployment workflow](./.github/workflows/deploy.yml).
-
-# Running Locally
-
-To start the landing page site locally, clone this repository and run the following.
-```
-git clone git@github.com:apache/iceberg-docs.git
-cd landing-page && hugo serve
-```
-
-To start the documentation site locally, clone this repository and run the following.
-```
-git clone git@github.com:apache/iceberg-docs.git
-git submodule update --init
-cd docs && hugo serve
-```
-
-# Scanning For Broken Links
-
-If you'd like to scan for broken links, one available tool is linkcheck that can be found [here](https://github.com/filiph/linkcheck).
+These are all deployed at the root level of the `asf-site` branch by the `Deploy redirects` step in the [deployment workflow](./.github/workflows/deploy.yml).
\ No newline at end of file