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.

Sign up for GitHub

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

Jump to bottom

[i18n-KO] fix: docs: ko: sagemaker anchors and _toctree.yml #22549

Merged
merged 1 commit into from
Apr 17, 2023
Merged

[i18n-KO] fix: docs: ko: sagemaker anchors and _toctree.yml #22549

merged 1 commit into from
Apr 17, 2023

Conversation

jungnerd
Copy link
Contributor

@jungnerd jungnerd commented Apr 4, 2023 •
edited

Co-authored-by: Wonhyeong Seo
wonhseo@kakao.com

What does this PR do?

I fixed the anchors and _toctree.yml

Part of #20179 (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Please review this PR: @sgugger

@wonhyeongseo wonhyeongseo mentioned this pull request Apr 4, 2023
Open
84 tasks
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 4, 2023 •
edited

The documentation is not available anymore as the PR was closed or merged.

@wonhyeongseo
Copy link
Contributor

wonhyeongseo commented Apr 4, 2023 •
edited

We are getting a 500 error (probably due to spacing issues in _toctree.yml). Please do not merge until the problem is resolved.

sgugger
sgugger reviewed Apr 4, 2023
View reviewed changes
Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

I think the error in the doc preview comes from bad yaml syntax in the modified toctree.

@wonhyeongseo
Copy link
Contributor

wonhyeongseo commented Apr 4, 2023 •
edited

I think the error in the doc preview comes from bad yaml syntax in the modified toctree.

Yes, I agree @sgugger . There were two titles for a section on L13-19. Editing _toctree.yml like so fixed the issue for me locally.
image

wonhyeongseo
wonhyeongseo suggested changes Apr 4, 2023
View reviewed changes
Copy link
Contributor

@wonhyeongseo wonhyeongseo left a comment •
edited

Choose a reason for hiding this comment

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

We should modify L13-19 to the following:

- sections:
  - sections:
    - local: sagemaker
      title: Amazon SageMaker에서 학습 실행하기
    - local: in_translation
      title: (번역 중)
    title: 일반 사용법
  - local: in_translation
    title: (번역 중)
  title: How-to 가이드

I apologize for any confusion I may have caused with my suggestion that removing a single dash would resolve the issue. I understand it may have been misleading.
Please let me know if you have further questions, @jungnerd !

docs/source/ko/_toctree.yml Outdated
title: Amazon SageMaker에서 학습 실행하기
- local: in_translation
title: (번역 중)
- title: 일반 사용법

This comment was marked as outdated.

Sign in to view

docs/source/ko/_toctree.yml Outdated
Comment on lines 13 to 22
- sections:
- local: in_translation
title: (번역 중)
- local: sagemaker
title: Amazon SageMaker에서 학습 실행하기
- local: in_translation
title: (번역 중)
title: 일반 사용법
title: How-to 가이드
Copy link
Contributor

Choose a reason for hiding this comment

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

Please note that L18 and L19 have the same indent level. Since a section cannot have two titles, doc-builder malfunctioned and returned a 500 error.

@wonhyeongseo
Copy link
Contributor

Also when squashing the commits, please fix the typo on Co-auth*e*red-by to Co-auth*o*red-by and add arrow brackets (<>) to the email.
You may also use Github Desktop to ease the process. Thank you for your PR @jungnerd and feel free to ask me any questions.

@wonhyeongseo
Copy link
Contributor

wonhyeongseo commented Apr 4, 2023 •
edited

Great work, @jungnerd !
You solved the issue; now please squash the commits into one. You can use

  • chat-gpt for the commit message and
  • Github Desktop to add co-authors

if you want. 🙌 Good night!

@wonhyeongseo
Copy link
Contributor

@jungnerd we can remove the _toctree.yml change completely as we updated it in the upstream ko: complete toctree commit. After that and rebasing, this PR should be good to go! Let's try to do this on Thursday.

@jungnerd @0525hhgus
@gabrielwithappy @sim-so @HanNayeoniee @wonhyeongseo
fix: docs: ko: sagemaker anchors and _toctree.yml
8d7e481 
Co-Authored-By: Hyeonseo Yun <0525_hhgus@naver.com>
Co-Authored-By: Gabriel Yang <gabrielwithhappy@gmail.com>
Co-Authored-By: Sohyun Sim <96299403+sim-so@users.noreply.github.com>
Co-Authored-By: Na Yeon Han <nayeon2.han@gmail.com>
Co-Authored-By: Wonhyeong Seo <wonhseo@kakao.com>
@jungnerd
Copy link
Contributor Author

May you please review this PR?
@sgugger, @ArthurZucker, @eunseojo

sgugger
sgugger approved these changes Apr 17, 2023
View reviewed changes
Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes!

@sgugger sgugger merged commit abbc96a into huggingface:main Apr 17, 2023
2 checks passed
@jungnerd jungnerd deleted the fix-ko-sagemaker branch April 17, 2023 14:55
novice03 pushed a commit to novice03/transformers that referenced this pull request Jun 23, 2023
@jungnerd @0525hhgus
@gabrielwithappy @sim-so @HanNayeoniee @wonhyeongseo @novice03
[i18n-KO] fix: docs: ko: sagemaker anchors and _toctree.yml (huggin…
979d7ef 
…gface#22549)

fix: docs: ko: sagemaker anchors and  `_toctree.yml`

Co-authored-by: Hyeonseo Yun <0525_hhgus@naver.com>
Co-authored-by: Gabriel Yang <gabrielwithhappy@gmail.com>
Co-authored-by: Sohyun Sim <96299403+sim-so@users.noreply.github.com>
Co-authored-by: Na Yeon Han <nayeon2.han@gmail.com>
Co-authored-by: Wonhyeong Seo <wonhseo@kakao.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wonhyeongseo wonhyeongseo wonhyeongseo requested changes

@sgugger sgugger sgugger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jungnerd @HuggingFaceDocBuilderDev @wonhyeongseo @sgugger