Moving docs from wiki to Docusaurus

[Yash-Raj-Singh]

Description

Moved all the docs from GitHub wiki to Docusaurus

Fixes #1083

Type of Change:

• Documentation

Code/Quality Assurance Only

• New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

Deployed on my local system

Checklist:

• [x] My PR follows the style guidelines of this project
• [x] I have performed a self-review of my own code or materials
• [x] I have made corresponding changes to the documentation

Code/Quality Assurance Only

• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes

Screenshots:

[Yash-Raj-Singh]

@devkapilbansal Have a look. By the way I have a query that how do I host it on https://anitab-org.github.io/mentorship-android/ ?

[isabelcosta]

@devkapilbansal Have a look. By the way I have a query that how do I host it on https://anitab-org.github.io/mentorship-android/ ?

@anitab-org/mentorship-maintainers does anyone have a advice for this? I can't remember exactly what is needed. I think this should help https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions

[devkapilbansal]

@Yash-Raj-Singh you need to have a workflow too for deploying it to gh-pages after every push to master.

@isabelcosta yes the link added above should be used to setup environment variables. I think this discussion can also help:- https://github.com/anitab-org/mentorship-backend/pull/841#issuecomment-805157098

[Yash-Raj-Singh]

@isabelcosta @devkapilbansal I have deployed the GitHub Page in my repo here is the link: https://yash-raj-singh.github.io/Docusaurus/

But I don't have permission to deploy on this repo.

[devkapilbansal]

Thanks for updating @Yash-Raj-Singh

@codesankalp can you please check what is left here?

[Yash-Raj-Singh]

@Yash-Raj-Singh Can you please add a CI build for deploying docs? You can take references from mentorship-backend-docs-ci.

@codesankalp So do I have to make same docs.yml in workflow folder or something else needs to be done. Actually I don't know about this CI build thing.

Btw if the code owner just write this command (cmd /C 'set GIT_USER=GITHUB_USERNAME&& yarn deploy') in powershell, it will be deployed automatically.

[codesankalp]

@codesankalp So do I have to make same docs.yml in workflow folder or something else needs to be done.

Yes.

Actually I don't know about this CI build thing.

You don't have to change anything in the CI and by doing this you can learn new things :smile:

Btw if the code owner just write this command (cmd /C 'set GIT_USER=GITHUB_USERNAME&& yarn deploy') in powershell, it will be deployed automatically.

Yes, we can but automation is always better than manual work. If docs changes in the future then the maintainer has to redeploy the things again which can be avoided using this CI build.

[isabelcosta]

@isabelcosta @devkapilbansal I have deployed the GitHub Page in my repo here is the link: https://yash-raj-singh.github.io/Docusaurus/

But I don't have permission to deploy on this repo.

This is amazing @Yash-Raj-Singh 🤗 🚀 Great work you did 🙌🏾 I wonder if it would be possible to have it on https://yash-raj-singh.github.io/mentorship-android like https://anitab-org.github.io/mentorship-backend/ 🤓

[Yash-Raj-Singh]

@isabelcosta @devkapilbansal I have deployed the GitHub Page in my repo here is the link: https://yash-raj-singh.github.io/Docusaurus/ But I don't have permission to deploy on this repo.

This is amazing @Yash-Raj-Singh 🤗 🚀 Great work you did 🙌🏾 I wonder if it would be possible to have it on https://yash-raj-singh.github.io/mentorship-android like https://anitab-org.github.io/mentorship-backend/ 🤓

@codesankalp has guided me to make CI Build, so just working on it.

[Yash-Raj-Singh]

@codesankalp Have a look and tell if anything else needs to be done. I guess it should be listed in Action page but its not. Why so?

[Yash-Raj-Singh]

@codesankalp Now it shows its presence 👍🏽 in Action Tab but docs are still not deployed. And for git config details, I copied this config from one of the yml file in ms-backend. Below one of the test is skipped also idk why

[codesankalp]

@codesankalp Now it shows its presence 👍🏽 in Action Tab but docs are still not deployed. And for git config details, I copied this config from one of the yml file in ms-backend. Below one of the test is skipped also idk why

Yes, that will run when the commit will be pushed to develop branch i.e. after merging of this pull request.

[Yash-Raj-Singh]

@isabelcosta @vj-codes Can you please review this PR?

[Yash-Raj-Singh]

Thanks @codesankalp for investing your time to guide me, it was really great and helped me to learn new things. I admire you reviewed my code. 👍🏽 🥇