chore: deployed documentation to gh pages

[vj-codes]

Description

added support for deploying documentation to Github pages

Fixes #234

Type of Change:

• Outreach
• Documentation

Checklist:

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

Code/Quality Assurance Only

• [ ] My changes generate no new warnings
• [ ] New and existing unit tests pass locally with my changes

[vj-codes]

The secrets will be either created by @mtreacy002 or the admins who have write access

[mtreacy002]

The secrets will be either created by @mtreacy002 or the admins who have write access

@vj-codes , I don't think I have that level of access to the repo (creating secret key/variable). @isabelcosta , can you please help us with this? Thanks beforehand 😉

[isabelcosta]

I will add the github keys as I did for mentorship :) @mtreacy002

[isabelcosta]

I followed this https://github.com/anitab-org/mentorship-backend/pull/841#issuecomment-808741268 which I think should work

[mtreacy002]

Hi @vj-codes and @isabelcosta . I've changed the deployed branch on the repo settings to gh-pages and re-run the workflow as you suggested in BIT Open Session last week so that the Docusaurus should be deployed properly. But I still see raw template of Docusaurus instead of the BIT backend Docusaurus like the one MS backend has. Do you know what went wrong here? BIT backend repo gh-pages setting:

What we can see on the deployed site (not-expected)

What we would like to see (as per MS backend docusaurus)

[mtreacy002]

PS: The deployment to gh-pages on the workflow still got skipped for some reason 🤔

cc @isabelcosta and @epicadk, can I have your thoughts on this, please?

[epicadk]

It's a pull request. If you have a look at the workflow it skips for pull requests.

[vj-codes]

@mtreacy002 after a bit of digging I found out that the content of docusaurus.config.js is a bit different here as compared to ms-backend. For example, the top part on ms-backend If you... is part of the config but absent on this repo TBH the home page for mentorship looks good so probably we can tweak the config here as well and the problemwould be fixed, what say? 👀

[mtreacy002]

@mtreacy002 after a bit of digging I found out that the content of docusaurus.config.js is a bit different here as compared to ms-backend. For example, the top part on ms-backend If you... is part of the config but absent on this repo TBH the home page for mentorship looks good so probably we can tweak the config here as well and the problemwould be fixed, what say? 👀

That sounds like a good idea, @vj-codes .

[vj-codes]

Should it be done in this PR or will I need to create a separate issue for the same? @mtreacy002

[mtreacy002]

I think we can do it on this one, @vj-codes . Btw, as per @epicadk mentioned, the docusaurus deployment seems to only happens after we merge this PR, coz it won't be deployed from a pull request branch. I probably will approve and merge once you add the additional note you've suggested. Hope this ok 😉

[mtreacy002]

@isabelcosta and @epicadk , we still have issue with the deployment to gh-pages. The error seems to be related to the ssh key as per the screenshot below. Can you please help form your side?

[vj-codes]

@mtreacy002 ran it locally, it looks similar to mentorship system. The problem is with the secret key 👀

[epicadk]

Busy with GSoC and college work. Assigning myself, I'll take a look when I'm free.

[mtreacy002]

Busy with GSoC and college work. Assigning myself, I'll take a look when I'm free.

Thank you, @epicadk. Take your time, no rush. Just ping us when you have time to look at it 😉

[isabelcosta]

@mtreacy002 and @vj-codes so during the mentorship session, we figured out that I had the wrong SSH Key configured, it should have been the private one 😅 Now there is another little bug, easy to fix. @vj-codes will take care of it 💪🏾