Port docs from Wiki to Docusaurus

anitab-org / portal

THIS PROJECT IS ARCHIVED. Systers Portal for communities.

GNU General Public License v2.0

68 stars 209 forks source link

Port docs from Wiki to Docusaurus #657

Closed SanketDG closed 4 years ago

SanketDG commented 4 years ago

Description

Right now, the whole Portal docs is in rhe repository wiki.

We are moving to Docusaurus (https://v2.docusarus.io)

Preview: anitab-portal.surge.sh

TODO:

[x] Add a basic minimal scaffold in docs/ (use Tinysaurus)
[x] Remove the old files from docs/
[ ] Remove any dependencies for the old docs. (sphinx for example)
[x] Convert all the markdown files from wiki and put it in docs (Thanks to @sakshi1499 for doing the heavy lifting :tada:)
[x] Categorize the Documentation in the right places
[x] Add any extra Documentation (can be done post-merge)
[x] Update the Footer
[ ] Deploy Strategy
- Netlify?
- Vercel?

Closes #648

We are mostly looking for comments on what goes in and what goes out of the whole porting. We won't add any documentation right now, (this may be done through future contributors)

We have also decided to not keep anything that is ephemeral, so nothing specific to GSoC or any other program

isabelcosta commented 4 years ago

I've quickly checked the preview, and this is amazing :D 👏 👏 👏

SanketDG commented 4 years ago

For the deployment purpose we can use GitHub pages, no need to maintain extra server..

We were thinking of going with Netlify or Vercel which are just better GH Pages :smile:

however there are many alternatives available like mkdocs(provides many themes) where no need to convert .md files to docs , can also be deployed like GitHub pages, etc..!!!

where no need to convert .md files to docs

We converted the Wiki's to .md, I am not sure what you mean here.

Any SSG for that matter does the same, just outputs a bunch of html/css/js files, I think we went with Docusaurus, because of UI and accessiblility.

sammy1997 commented 4 years ago

@sakshi1499 @mayburgos Can you add your reviews so that we can merge this?

mayburgos commented 4 years ago

@sakshi1499 @mayburgos Can you add your reviews so that we can merge this?

Please move forward without my review, thank you!

sakshi1499 commented 4 years ago

@sammy1997 I didn't want to approve our own PR. Can you please go ahead and merge this?

annabauza commented 3 years ago

@SanketDG can you please tell me if I can host it on github static pages? If yes what do I need to do to prepare static page?

SanketDG commented 3 years ago

@annabauza

can you please tell me if I can host it on github static pages? If yes what do I need to do to prepare static page?

$ yarn build

should put the static files in build/ folder, which can just be uploaded to github pages.

The rest of the instructions are in the README.

annabauza commented 3 years ago

I figured it out thanks