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

Set Up Initial Documentation #4

Open
erikaheidi opened this issue Oct 8, 2020 · 3 comments
Open

Set Up Initial Documentation #4

erikaheidi opened this issue Oct 8, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@erikaheidi
Copy link
Contributor

Set up documentation. Priorities:

  • About
  • Contributing.md file
  • How to set up the development environment
  • How to deploy to production on App Platform and other methods (less priority initially)
@erikaheidi erikaheidi added the documentation Improvements or additions to documentation label Oct 8, 2020
@lynmuldrow
Copy link

I can tackle this one, too. Happy to gain initial thoughts/ideas around communicating this content to mock something up for review.

@erikaheidi
Copy link
Contributor Author

Hey @lynmuldrow thanks for grabbing this one!

I think that for the end user we must have something showing details of how to set up / deploy within a real web server, but maybe that can wait a bit until we have more constrains about the setup. In terms of practicality, I was considering using readthedocs.org to host the docs, I used it in the past and it sounds like something good for the long term.

By the way, I'm totally open to any suggestions and ideas.

@lynmuldrow
Copy link

I totally agree and think that it would be wise to wait until we have a flow that makes sense for end users.

I think readthedocs is a great choice and is community-minded, which we'd like to def promote.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants