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.

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

Bug: The Developer installation UX must be improved #1384

Closed
palisadoes opened this issue Jan 12, 2023 · 2 comments
Closed

Bug: The Developer installation UX must be improved #1384

palisadoes opened this issue Jan 12, 2023 · 2 comments
Labels
bug Something isn't working documentation Update documentation no-issue-activity No issue activity

Comments

@palisadoes
Copy link
Contributor

Our INSTALATION.md documentation is incomplete which makes it difficult for new Talawa contributors to add new features and fix bugs.

The existing INSTALLATION.md file must clearly explain:

  1. The pre-requisite Talawa apps that must be running before the mobile app will work and why.
  2. The default URLs to use to interact with this and any other Talawa apps where applicable.
  3. All the possible configuration parameters that can be used.
  4. What needs to be done after changing any configuration parameter (if necessary)
  5. The preferred way to install the app as a developer
  6. The preferred way to install the app as a non-developer

Links to the INSTALLATION.md files of other repos should be used to help remove ambiguity.

The existing CONTRIBUTING.md file must:

  1. only refer to the INSTALLATION.md file for setting up the app.

This is being classified as a bug as the resolution of this issue will make the app run more predictably.

@palisadoes palisadoes added the bug Something isn't working label Jan 12, 2023
@github-actions github-actions bot added documentation Update documentation unapproved Unapproved, needs to be triaged labels Jan 12, 2023
@AntoTomAbraham
Copy link

Can you assign this work to me. I will help to add pre-request apps to be installed, default URL, configuration parameters.

@github-actions
Copy link

This issue did not get any activity in the past 14 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

@github-actions github-actions bot added the no-issue-activity No issue activity label Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Update documentation no-issue-activity No issue activity
Projects
None yet
Development

No branches or pull requests

2 participants