bitsondatadev opened a new pull request, #8659: URL: https://github.com/apache/iceberg/pull/8659
This PR is a culmination of my work in the [making-iceberg-docs](https://github.com/bitsondatadev/making-iceberg-docs) repository. To see a preview, you can [check out the GitHub page](https://bitsondatadev.github.io/making-iceberg-docs/). We will eventually want to migrate this to using the iceberg GitHub pages to deploy the docs. Design Discussion: https://lists.apache.org/thread/nq283g83p9cgx518jwo7dg85fm5gjrvv Design Doc: https://docs.google.com/document/d/1WJXzcwC6isfoywcLY2lZ9gZN6i0JU1I2SIZmCkumbZc/edit#heading=h.gli9mc2ghfz1 Phase 1 Goals: - Avoid changing the words and content themselves. - Migrate away from Hugo front matter and syntax and migrate to [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) syntax. - Fix broken links and verify using linkchecker. - Add [Vale](https://vale.sh/) but initially disabled to hold off on doing too much. - Combine the static (evergreen) pages and the versioned documentation into a single repository. - Adjust the structure to match the layout of the website itself, where `./home/*.md` contains the evergreen content and `./home/docs/<version>/*.md` contains the versions of Iceberg. - Keep all versioned javadocs in [their own tag](https://github.com/bitsondatadev/making-iceberg-docs/tree/javadoc). - Keep each version of the versioned Iceberg docs in [their own tag](https://github.com/bitsondatadev/making-iceberg-docs/tree/docs-1.3.1) separate from the [equivalent release tag](https://github.com/apache/iceberg/tree/apache-iceberg-1.3.1) to enable future updates to older doc versions. - Set up an all encompassing build using Spotify's [backstage/mkdocs-monorepo-plugin](https://github.com/backstage/mkdocs-monorepo-plugin) and [git worktrees](https://git-scm.com/docs/git-worktree) to build multiple sub-repositories to include the static root pages, the javadoc, and docs tags, and deploy these in a single site that is searched on. - Ensure backwards compatibility with the existing site urls to avoid breaking permalinks. Phase 2/3 and Todos: - Style the webpage to match the existing <https://iceberg.apache.org>. - Getting Started guide. - Split content based on [diataxis framework](https://diataxis.fr/). - Fix linting errors and add Vale to the build process. - Add linkChecker to the build process. - Move python docs to pyIceberg repo and build a submodule. - Set up Rust/Go docs sites. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
