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

Restructured the website repo to allow for future i18n and content translation #1909

Merged
merged 11 commits into from Apr 21, 2020

Conversation

sarahmaddox
Copy link
Contributor

@sarahmaddox sarahmaddox commented Apr 20, 2020

Preview: https://deploy-preview-1909--competent-brattain-de2d6d.netlify.app/

Fixes #1127

Notes:

  • For a full description of what needs to be done for translation of the docs, see the product requirements doc: http://bit.ly/kubeflow-i18n
  • I thought about moving the images into the /static/ directory so that we could share them across languages - but that would break the structure of the OWNERS files.
  • After testing the redirects, I've discovered that the _redirects file needs to be in the language subdirectory. That is, for the English docs, the _redirects file must be in /en/.
  • I've removed the Kubeflow customization of the logic to create the Edit this page URL, in the Docsy partial template at https://github.com/kubeflow/website/blob/master/layouts/partials/page-meta-links.html#L9. Now that Kubeflow has the /en/ directory, the Docsy logic should work. Note that it won't work until we've merged this PR. Click Edit this page on any page to see the URL constructed by the logic. Remove the /en part of the path to make the link work in the current directory structure (before this PR is merged).

@kubeflow-bot
Copy link

This change is Reviewable

@sarahmaddox sarahmaddox changed the title WIP i18n Restructured the website repo to allow for future i18n and content translation Apr 20, 2020
@sarahmaddox
Copy link
Contributor Author

/assign @joeliedtke
/assign @abhi-g
/assign @janeman98

This PR is now ready for review. Applying a hold to give us time for a careful review.
/hold

@janeman98 @joeliedtke @abhi-g Please would you take a look? See the PR description for preview link and more context.

@janeman98
Copy link
Contributor

Thanks @sarahmaddox
Click Edit this page on any page to see the URL constructed by the logic. Remove the /en part of the path to make the link work in the current directory structure (before this PR is merged).

I am looking at the preview. May I know where to find Edit this page in the preview?

@sarahmaddox
Copy link
Contributor Author

Hallo @janeman98, the link is at the top right of every page, in the same panel that shows the list of headings on the page. If you're using a small screen, the panel may not appear. Try reducing the zoom factor in your browser.

@janeman98
Copy link
Contributor

Hallo @janeman98, the link is at the top right of every page, in the same panel that shows the list of headings on the page. If you're using a small screen, the panel may not appear. Try reducing the zoom factor in your browser.

Thanks @sarahmaddox ! I need to maximize my screen to see it. I am good now.

@janeman98
Copy link
Contributor

I have randomly tested >40 pages in the preview. All worked as what mentioned above.

/lgtm

Copy link
Member

@abhi-g abhi-g left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks @sarahmaddox

@k8s-ci-robot k8s-ci-robot removed the lgtm label Apr 21, 2020
@sarahmaddox
Copy link
Contributor Author

/hold cancel

Thanks @abhi-g and @janeman98 - could you re-LGTM now that I've merged with master?

@abhi-g
Copy link
Member

abhi-g commented Apr 21, 2020

/lgtm

@sarahmaddox
Copy link
Contributor Author

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sarahmaddox

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit d0bd0e0 into kubeflow:master Apr 21, 2020
yhwang added a commit to yhwang/website that referenced this pull request Jun 22, 2020
Fix broken links becaure of kubeflow#1909. The preparation change for i18n adds
an extra direcotry `en` under `content` directory. The links in README.md
which point to files under `content` directory become invalid. This
change fixes all those broken links by adding the `en` into the path.
k8s-ci-robot pushed a commit that referenced this pull request Jun 26, 2020
Fix broken links becaure of #1909. The preparation change for i18n adds
an extra direcotry `en` under `content` directory. The links in README.md
which point to files under `content` directory become invalid. This
change fixes all those broken links by adding the `en` into the path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the docs structure to support internationalization of the docs
6 participants