Add contribution guidelines #35
Conversation
|
|
||
| ## 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: |
There was a problem hiding this comment.
need to refine this workflow a bit, does the docs/content/docs path contains all the documentations user might modify?
There was a problem hiding this comment.
Looks like there is another part in the landing-page/content/common
There was a problem hiding this comment.
okay so I assume the iceberg repo would have a documentation folder and common and docs folder inside mapping to the 2 sites here.
There was a problem hiding this comment.
Yep, exactly right. In apache/iceberg we would have two directories that are intuitively named like documentation/common and documentation/versioned and they would hold the contents in docs/content/docs and landing-page/content/common, respectively. The release manager would then just do a full hard-copy over of those two directories (might be worth mentioning that it should be a full copy, meaning deleted files are removed in the destinations as well).
There was a problem hiding this 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.
There was a problem hiding this comment.
got it, let me update based on this info
| 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 |
There was a problem hiding this comment.
I moved up contribution guide because readers are most likely interested in that
samredai
left a comment
samredai
left a comment
There was a problem hiding this comment.
A few comments and nits but overall LGTM. Thanks @jackye1995 for adding this!
README.md
Outdated
| ## 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. |
README.md
Outdated
| 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. |
There was a problem hiding this comment.
The landing-page site includes the common markdown files as well (releases, spec, community, etc). We should keep those in apache/iceberg too and have PRs opened there, right? That would be simpler--all docs PRs are opened in apache/iceberg unless you're hotfixing a previous version in which case you open the PR against that particular version's branch in apache/iceberg-docs.
There was a problem hiding this comment.
yes agree, forgot to update this sentence after updating the scripts
README.md
Outdated
|
|
||
| ## Reporting Issues | ||
|
|
||
| All issues related to documentation and website should still be submitted to the [Iceberg repository](https://github.com/apache/iceberg). |
There was a problem hiding this comment.
s/to documentation and website/to the documentation website
README.md
Outdated
|
|
||
| ## Running Locally | ||
|
|
||
| To start the landing page site locally, clone this repository and run the following. |
There was a problem hiding this comment.
nit: the code block includes the clone so maybe just say "To start the landing page site locally, run the following."
There was a problem hiding this comment.
I will move the git clone part to another line, let me know what you think
README.md
Outdated
| cd landing-page && hugo serve | ||
| ``` | ||
|
|
||
| To start the documentation site locally, clone this repository and run the following. |
There was a problem hiding this comment.
nit: same comment about the clone already being included in the code block.
|
|
||
| ## 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: |
There was a problem hiding this comment.
Yep, exactly right. In apache/iceberg we would have two directories that are intuitively named like documentation/common and documentation/versioned and they would hold the contents in docs/content/docs and landing-page/content/common, respectively. The release manager would then just do a full hard-copy over of those two directories (might be worth mentioning that it should be a full copy, meaning deleted files are removed in the destinations as well).
3 participants
No description provided.