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 Talawa-Admin Installation Documentation for Talawa #1389

Closed
palisadoes opened this issue Jan 20, 2023 · 5 comments · Fixed by #1390
Closed

Improve Talawa-Admin Installation Documentation for Talawa #1389

palisadoes opened this issue Jan 20, 2023 · 5 comments · Fixed by #1390
Assignees
@SiddheshKukade
Labels
bug Something isn't working documentation Update documentation

Comments

@palisadoes
Copy link
Contributor

In Talawa's INSTALLATION.md document under the Developer Environment Setup heading, there is extensive setup instructions for Talawa-Admin where they should be in the Talawa-Admin INSTALLATION.md file instead. The Talawa instructions must be updated when this is done.

Where necessary we need to update both the documentation and the code base accordingly.

This is a joint issue with: PalisadoesFoundation/talawa-admin#390
@palisadoes palisadoes added the bug Something isn't working label Jan 20, 2023
@github-actions github-actions bot added documentation Update documentation unapproved Unapproved, needs to be triaged labels Jan 20, 2023
@palisadoes palisadoes mentioned this issue Jan 20, 2023
Closed
@AmanGit010
Copy link

So we basically want to move the instructions provided under Developer Environment Setup in the Talawa's instruction.md file to Talawa-admin's instruction.md file right? and also update the Talawa instructions for setting up the developer environment locally for Flutter.

I would love to work on this issue, please assign me this issue. @palisadoes

@SiddheshKukade
Copy link
Member

SiddheshKukade commented Jan 20, 2023 •
edited

I think we should just add a link pointing out to this INSTALLATION.md file to fix this. I'd like to take this if that's okay.

@palisadoes
Copy link
Contributor Author

palisadoes commented Jan 20, 2023 •
edited

So we basically want to move the instructions provided under Developer Environment Setup in the Talawa's instruction.md file to Talawa-admin's instruction.md file right? and also update the Talawa instructions for setting up the developer environment locally for Flutter.

I would love to work on this issue, please assign me this issue. @palisadoes

@AmanGit010

  1. It requires accepting to fixing this and the joint issue with: Improve Talawa-Admin Installation Documentation talawa-admin#390. There will need to be code changes with this issue.
  2. Yes, we should move the section in this to the just link to the Talawa-Admin INSTALLATION.md file.

So...

  1. Are you willing to do both? Typescript knowledge will be necessary.
  2. Can you complete this over the weekend? If not I'll have to reassign it.

@palisadoes
Copy link
Contributor Author

@SiddheshKukade Please also add a table of contents to this INSTALLATION.md file for readability

@palisadoes palisadoes removed the unapproved Unapproved, needs to be triaged label Jan 20, 2023
@AmanGit010
Copy link

I think we should just add a link pointing out to this INSTALLATION.md file to fix this. I'd like to take this if that's okay.

I was working on this, anyways no problem
go ahead 👍🏻

@SiddheshKukade SiddheshKukade mentioned this issue Jan 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SiddheshKukade SiddheshKukade

Labels
bug Something isn't working documentation Update documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve Talawa-Admin Installation Documentation for Talawa SiddheshKukade/talawa
3 participants
@palisadoes @SiddheshKukade @AmanGit010