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

What needs to be documented? #1171

Closed
chrismedrela opened this issue Apr 1, 2017 · 4 comments

Comments

Projects
None yet
2 participants
@chrismedrela
Copy link
Collaborator

commented Apr 1, 2017

@maneesha you mentioned that we need more documentation. What exactly should be documented? I'm enumerating some ideas below.

  1. description of infrastructure (automatic backups, server configuration, Travis CI)
  2. procedures for deployment, release; or restoring from a backup (we've never done it yet)
  3. how to run AMY on your machine
  4. how to contribute (quick start for new contributors)
  5. AMY feature documentation
  6. release notes
  7. user manuals (how to use AMY as a user; podcasts could be a good format)
  8. developer documentation:
    1. directory hierarchy
    2. architecture (how AMY is split into multiple Django apps, what external APIs do we use etc.)
    3. description of models
    4. API reference
    5. REST API reference
  9. something related to PyData?
  10. FAQ
  11. Troubleshooting documentation
@maneesha

This comment has been minimized.

Copy link
Contributor

commented Apr 4, 2017

All of the above.
(although I don't know anything about how this is used for PyData)

@chrismedrela

This comment has been minimized.

Copy link
Collaborator Author

commented Apr 4, 2017

@maneesha Sorry, I asked wrong question. What needs to be documented in the first place? What should we focus on?

@maneesha

This comment has been minimized.

Copy link
Contributor

commented Apr 5, 2017

For all of you, I'd start with item 8 (developer documentation). There's probably things in items 1-5 that are related to the developer documentation. I believe that @pbanaszkiewicz has been blogging release notes so we should have that already, correct?

For item 7 (user manual), 10 (FAQ), and 11 (troubleshooting), I've already put together a lot of notes offline. I can work on publishing these over the next few months.

@maneesha

This comment has been minimized.

Copy link
Contributor

commented Jul 13, 2019

Closing this
Per @pbanaszkiewicz developer documentation is complete in the docs folder in this repo.

End user documentation is complete in The Carpentries Handbook.

@maneesha maneesha closed this Jul 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.