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

Improve details about Travis CI deployment in docs #3189

Closed
neo-sam opened this issue Aug 2, 2020 · 2 comments · Fixed by #3565
Closed

Improve details about Travis CI deployment in docs #3189

neo-sam opened this issue Aug 2, 2020 · 2 comments · Fixed by #3565
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship

Comments

@neo-sam
Copy link
Contributor

neo-sam commented Aug 2, 2020

📚 Documentation

I followed the Travis CI deployment steps:

https://v2.docusaurus.io/docs/deployment/#triggering-deployment-with-travis-ci

The problem is that you have to allow more permissions scopes in personal access token for successful building, otherwise build fail:

image

Edit my token access permission in GitHub: (Maybe less permissions also work successfully)

image

image

Passed!

I think it is necessary to explain this clearly in the docs.

Have you read the Contributing Guidelines on issues?

Yes
@neo-sam neo-sam added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers labels Aug 2, 2020
@slorber
Copy link
Collaborator

slorber commented Aug 3, 2020

Hi,

Agree we could do a better job here, can you help us improve this part of the doc by submitting a PR?

Maybe we could create a full section about github token creation, as it's also used on the Azure deployment doc (looks like a copy/paste)

@slorber slorber added difficulty: advanced Issues that are complex, e.g. large scoping for long-term maintainability. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. and removed status: needs triage This issue has not been triaged by maintainers difficulty: advanced Issues that are complex, e.g. large scoping for long-term maintainability. labels Aug 3, 2020
@jordanliu
Copy link
Contributor

@LittleboyHarry need help with the PR?

@russtaylor russtaylor mentioned this issue Oct 9, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. mlh Major League Hacking Fellowship
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(v2): deployment, add required Github token scope infos russtaylor/docusaurus
3 participants
@slorber @jordanliu @neo-sam