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.

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

Convert Hugo versioned docs to mkdocs format #9591

Merged
merged 1 commit into from
Feb 1, 2024

Conversation

bitsondatadev
Copy link
Collaborator

@bitsondatadev bitsondatadev commented Jan 30, 2024

This PR updates the versioned docs from Hugo to mkdocs format.

  • Removes Hugo front matter.
  • Make the filename and the url equivalent
    • branching-and-tagging.md to branching.md
  • Standardize links to mkdocs format to avoid this.
  • MkDocs specific formatting such as:
    • {{% icebergVersion %}} to {{ icebergVersion }}
    • {{< hint info >}} to !!! info
  • Fix broken links from previous site.
  • Some minor spelling and grammar fixes.

Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

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

I ran the docs locally, went through quite a few pages, and it looks good.

docs/docs/branching.md Show resolved Hide resolved
docs/docs/flink.md Outdated Show resolved Hide resolved
@rice668
Copy link
Contributor

rice668 commented Feb 1, 2024

Hi, @bitsondatadev Just a ask, why do we need to make this change ?

@bitsondatadev
Copy link
Collaborator Author

@rice668 see: #8151 and #9520

@Fokko
Copy link
Contributor

Fokko commented Feb 1, 2024

This looks good, thanks @bitsondatadev 🙌

@Fokko Fokko merged commit ed28898 into apache:main Feb 1, 2024
2 checks passed
devangjhabakh pushed a commit to cdouglas/iceberg that referenced this pull request Apr 22, 2024
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.

None yet

4 participants