Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[HUDI-986] Support staging site for per pull request #1698

Closed
wants to merge 1 commit into from
Closed

[HUDI-986] Support staging site for per pull request #1698

wants to merge 1 commit into from

Conversation

lamberken
Copy link
Member

@lamberken lamberken commented Jun 2, 2020 •
edited

What is the purpose of the pull request

Support staging site for per pull request.

Brief change log

  • Modify relative path
  • Add support staging site docs

Verify this pull request

https://lamber-ken.github.io/hudi-staging-site

Committer checklist

  • Has a corresponding JIRA in PR title & commit

  • Commit message is descriptive of the change

  • CI is green

  • Necessary doc changes done or have another open PR

  • For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.

@lamberken lamberken marked this pull request as draft June 2, 2020 17:01
@lamberken
Copy link
Member Author

Building staging docs

When you submit a pull request for any changes on websites or docs, we recommend you generate staging site for review.

You can refer to the following steps:

  1. You need to create a github repo called hudi-staging-site under your github account. You can fork this staging repo as well.
  2. In your hudi-staging-site repo, go to Settings > GitHub Pages. Enable GitHub Pages on master branch.
  3. Make changes to the website, follow the steps above to verify the changes locally.
  4. Once the changes are verified locally, you can run following command, It will generate the files under docs/_site.
    bundle exec jekyll serve --config _config.yml,_config.staging.yml.
  5. Push the generated website to your hudi-staging-site.
  6. Your changes will be live on https://<your-github-id>.github.io/hudi-staging-site.

@vinothchandar vinothchandar self-assigned this Jun 3, 2020
@vinothchandar
Copy link
Member

@xushiyan are you able to help review this

@xushiyan
Copy link
Member

xushiyan commented Jun 3, 2020

@xushiyan are you able to help review this

Sure i can help with this.

@lamberken lamberken marked this pull request as ready for review June 4, 2020 03:36
@lamberken
Copy link
Member Author

hello @xushiyan, this pr is ready for review now : )

@lamberken lamberken mentioned this pull request Jun 5, 2020
Closed
5 tasks
xushiyan
xushiyan reviewed Jun 7, 2020
View reviewed changes
Copy link
Member

@xushiyan xushiyan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good. Just saw some issue with some links. This image
https://lamber-ken.github.io/assets/images/blog/2020-05-28-datadog-metrics-demo.png
that is linked from this page doesn't seem to show up.

docs/_docs/0_3_migration_guide.cn.md Outdated Show resolved Hide resolved
docs/_pages/contributing.cn.md Show resolved Hide resolved
docs/_pages/releases.cn.md
@@ -7,7 +7,7 @@ last_modified_at: 2019-12-30T15:59:57-04:00
language: cn
---

## [Release 0.5.2-incubating](https://github.com/apache/hudi/releases/tag/release-0.5.2-incubating) ([docs](/docs/0.5.2-quick-start-guide.html))
## [Release 0.5.2-incubating](https://github.com/apache/hudi/releases/tag/release-0.5.2-incubating) ([docs]({{ site.baseurl }}/docs/0.5.2-quick-start-guide.html))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

docs/_pages/releases.cn.md Show resolved Hide resolved
xushiyan
xushiyan approved these changes Jun 10, 2020
View reviewed changes
Copy link
Member

@xushiyan xushiyan left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor optional suggestion: if site.baseurl can infer from file name to add language segment, that'll be great. e.g., mypage.cn.md makes site.baseurl adding /cn. Not sure if this is possible.

Overall LGTM so approving.

docs/_docs/0_3_migration_guide.md
@@ -51,7 +51,7 @@ for partition in [list of partitions in source table] {

**Option 3**
Write your own custom logic of how to load an existing table into a Hudi managed one. Please read about the RDD API
[here](/docs/quick-start-guide.html). Using the HDFSParquetImporter Tool. Once hudi has been built via `mvn clean install -DskipTests`, the shell can be
[here]({{ site.baseurl }}/docs/quick-start-guide.html). Using the HDFSParquetImporter Tool. Once hudi has been built via `mvn clean install -DskipTests`, the shell can be
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to sync up with cn docs, also need -DskipITs

@vinothchandar vinothchandar added this to Ready For Review in PR Tracker Board Apr 15, 2021
@vinothchandar
Copy link
Member

cc @vingov wondering if we can provide something like this for the new site as well.

Closing this since we have moved off jekyll even since

PR Tracker Board automation moved this from Under Discussion PRs to Done Sep 7, 2021
@vingov
Copy link
Contributor

vingov commented Sep 9, 2021

@vinothchandar - yes, good idea, created this HUDI-2407 Jira to track this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xushiyan xushiyan xushiyan approved these changes

Assignees

@vinothchandar vinothchandar

Labels
None yet
Projects
PR Tracker Board
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@lamberken @vinothchandar @xushiyan @vingov