[
https://issues.apache.org/jira/browse/HUDI-1985?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17391021#comment-17391021
]
ASF GitHub Bot commented on HUDI-1985:
--------------------------------------
vingov commented on pull request #3366:
URL: https://github.com/apache/hudi/pull/3366#issuecomment-890382200
Summary of changes:
1. Docusaurus doesn't have the concept of permalink in the header, the URL
is formed based on the folder and file name, hence renamed all the files with
the permalink to preserve the old path and to avoid broken links for the docs.
2. Since the new navigation structure is different for the non-doc static
pages, I've updated all the references in the document.
3. Docusaurus doesn't support a few of the Jekyll features like:
- The HTML class attribute should be called className, hence updated those.
- In some cases, the <span> tag messes up the formatting of the content
hence got rid of it.
- Fixed the broken HTML tags.
- For loops got converted to a theme component for the powered-by page.
- Keywords should be an array instead of a comma-separated string.
4. Rebuilt the left sidebar and all old docs version sidebar and the main
dropdown navigation.
5. Moved around a bunch of files and renamed some to support versioning and
i18n support.
6. Most of the classic theme looked good already out of the box, fixed a
bunch of them in the src/css/custom.css.
7. Rebuild the home page as a pure js rendered page src/pages/index.js.
8. Built the footer navigation with all relevant links to improve the SEO
and ease of use and improve the visibility of the inner pages.
9. Broken the releases page to individual pages, to improve the usability
and to support the left side bar.
10. Broken the community page into 3 pages:
- Get Involved.
- Team.
- How to Contribute
11. Added the code tab support for the quick-start spark guide, the same
could be easily applied for other pages.
Please refer to the [docusaurus official documentation
](https://docusaurus.io/docs/markdown-features)for adding more features to the
site.
This is not the final version, the first step in the process is to migrate
the content as-is with few minor changes to the docusaurus platform, then we
can make incremental changes to add more features.
I'll be adding the search bar in the next iteration.
These sed one-liners saved the day for me!!
```
sed -i '' -E 's/src=("[^"]*")/src={require(\1).default}/g' *.md
sed -i '' -E 's/keywords:(.*)$/keywords: [\1]/g' *.md
sed -i '' -E 's/<br>/<br\/>/g' *.md
sed -i '' -E 's/style=("[^"]*")//g' *.md
sed -i '' -E 's/class=("[^"]*")/className=\1/g' *.md
sed -i '' -E 's|/docs/0.5.0-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.5.1-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.5.2-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.5.3-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.6.0-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.7.0-|/docs/|g' *.md
sed -i '' -E 's|/docs/0.8.0-|/docs/|g' *.md
find . -name '*.md' -exec sed -i '' '/permalink:/d' {} +
for filename in *.cn.md; do mv $filename ${filename//cn.md/md}; done
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
> Website re-design implementation
> --------------------------------
>
> Key: HUDI-1985
> URL: https://issues.apache.org/jira/browse/HUDI-1985
> Project: Apache Hudi
> Issue Type: Improvement
> Components: Docs
> Reporter: Raymond Xu
> Assignee: Vinoth Govindarajan
> Priority: Blocker
> Labels: documentation, pull-request-available
> Fix For: 0.9.0
>
>
> To provide better navigation and organization of Hudi website's info, we have
> done a re-design of the web pages.
> Previous discussion
> [https://github.com/apache/hudi/issues/2905]
>
> See the wireframe and final design in
> [https://www.figma.com/file/tipod1JZRw7anZRWBI6sZh/Hudi.Apache?node-id=32%3A6]
> (login Figma to comment)
> The design is ready for implementation.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
