anitab-forms-backend icon indicating copy to clipboard operation
anitab-forms-backend copied to clipboard

[docs] Migrate docusaurus deployment from surge to gh-pages

Open codesankalp opened this issue 4 years ago • 8 comments

Is your feature request related to a problem? Please describe.

It will be better to have the docs on the github-pages.

Describe the solution you'd like

Deploy the docs on gh-pages. Take reference from this: anitab-org/mentorship-backend@4cc78ae

codesankalp avatar Mar 28 '21 03:03 codesankalp

Hey @codesankalp when the label changes to Needs review on #136 I would like to work on this issue as well because if the issue is in reviewing phase then we can claim other issues as well right?

Amulya-coder avatar Apr 25 '21 19:04 Amulya-coder

@Amulya-coder would you still like to work on this?

isabelcosta avatar Oct 08 '21 18:10 isabelcosta

@isabelcosta hello, me again, I would like to try and tackle this one 😁

wizardlekic avatar Oct 15 '21 19:10 wizardlekic

@isabelcosta You can make this issue available to other contributors

Amulya-coder avatar Oct 16 '21 09:10 Amulya-coder

@WizardLemon You can go ahead :+1:

codesankalp avatar Oct 16 '21 11:10 codesankalp

I've tried to test out deployment on my own branch, but I'm having some trouble setting up the appropriate secret key for deployment.

I'll investigate it for a while longer, and I'll continue on with it tomorrow, but for now I'm putting up the PR so that the workflow file can be reviewed, maybe someone knows what needs to be done, or can give me some helpful advice.

wizardlekic avatar Oct 17 '21 19:10 wizardlekic

Update: I've managed to successfully deploy the documentation to https://wizardlemon.github.io/anitab-forms-backend/ using the workflow actions after updating the docusaurus config file.

I've figured out the issues I had with secret keys, and the config file also needed to be updated. If there's any more assistance that's neccessary with this migration, or if documentation updated are necessary as well, I'm available 😁

wizardlekic avatar Oct 17 '21 20:10 wizardlekic

I think this https://docusaurus.io/docs/deployment#deploying-to-github-pages will allow me to configure things correctly. But if you feel there is any documentation about this that is related specifically to this project, feel free to create it or create an issue for it ;)

isabelcosta avatar Oct 17 '21 20:10 isabelcosta