Skip to content

Conversation

@jackye1995
Copy link
Contributor

@jackye1995 jackye1995 commented Feb 8, 2022

@samredai @rdblue

Second step for new documentation site migration, add contents:

  • from iceberg-docs/docs/content/docs to iceberg/documentation/versioned
  • from iceberg-docs/landing-page/content/common to iceberg/documentation/common

Also update labeler for documentation to point to documentation/**/*

@github-actions github-actions bot added the INFRA label Feb 8, 2022
@jackye1995
Copy link
Contributor Author

Did a direct copy using:

cp -r ../iceberg-docs/docs/content/docs documentation/versioned
cp -r ../iceberg-docs/landing-page/content/common documentation/common

License missing for all redirect files:

 !????? /home/runner/work/iceberg/iceberg/documentation/common/project/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/api/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/api/javadoc/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/asf/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/community/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/community/blogs.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/community/join.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/community/talks.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/flink/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/format/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/format/spec.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/format/terms.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/integrations/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/benchmarks.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/how-to-release.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/roadmap.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/security.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/project/trademarks.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/releases/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/releases/release-notes.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/releases/0.12.1/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/releases/0.13.0/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/releases/latest/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/spark/_index.md
 !????? /home/runner/work/iceberg/iceberg/documentation/versioned/tables/_index.md

My view is that we can remove these files in the Iceberg repo, when we sync to iceberg-docs repo we do a rsync instead of cp -r to ensure existing files without change are not removed in iceberg-docs. Any thoughts?

@samredai

@samredai
Copy link
Contributor

samredai commented Feb 8, 2022

All of the markdown files that contain content can just have the license headers added right below the hugo front matter and it will be detected by the license check. That's also true for the _index.md files but hugo will then consider that a file with content and there are other implications like the section titles in the left nav will be hyperlinked but show an empty page.

We should be able to solve this by adding *_index.md to the .rat-excludes file. I think this is ok since those don't have any content in them anyway and just hold the section header names or an external link. Then adding the license header below the --- front matter will allow those to pass the check.

@jackye1995
Copy link
Contributor Author

jackye1995 commented Feb 8, 2022

Yes I noticed the UI changes when trying to add license to those files, that's why I was suggesting to not include those files in the main repo.

But I did not know we can exclude files from license checks, that sounds like a much better solution, I will do that instead, thanks for the suggestion!

Comment on lines 1 to 4
---
url: blogs
weight: 200
---
Copy link
Contributor

@kbendick kbendick Feb 8, 2022

Choose a reason for hiding this comment

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

Does this file need to be in the rat excludes too because the license isn't at the start?

EDIT: Sorry. I see that the rat step passed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, license just need to exist, no need to be at start

@jackye1995
Copy link
Contributor Author

@samredai @rdblue @kbendick updated to use docs instead of documentation as folder. Let me know if there is anything else.

@samredai
Copy link
Contributor

samredai commented Feb 8, 2022

lgtm, thanks @jackye1995!

Copy link
Contributor

@kbendick kbendick left a comment

Choose a reason for hiding this comment

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

+1. Thanks @jackye1995!

I haven't opened this locally, but at least the change from documentation -> docs I can say I looked through pretty closely (and the content).

Can run locally if needed but we can update if something seems off.

@jackye1995
Copy link
Contributor Author

@samredai @kbendick thanks for the review, I will merge it for now since it's blocking all the doc related updates. We can update anything missing in subsequent PRs if necessary.

@jackye1995 jackye1995 merged commit c47d8cf into apache:master Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants