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

add HOWTO build/deploy docs and other developer sections to docs #79

Open
mikofski opened this issue May 9, 2018 · 1 comment
Open

add HOWTO build/deploy docs and other developer sections to docs #79

mikofski opened this issue May 9, 2018 · 1 comment

Comments

@mikofski
Copy link
Contributor

mikofski commented May 9, 2018 •
edited
Loading

problem

there is no developer section in the docs, contributors don't know how to update, build, or deploy docs, any arbitrary conventions or traditions that have been established are undocumented.

proposal

add a Developer section to the docs that has HOWTO sections on:

  • building/deploying docs
  • conventions
  • CI setup
  • overall codebase structure/philosophy
  • HACKING - HOWTO setup git using feature-branch workflow
  • CONTRIBUTION - code of conduct, issue template
mikofski referenced this issue May 9, 2018
minor doc changes
767c4c9
@mikofski
Copy link
Contributor Author

mikofski commented May 9, 2018 •
edited
Loading

see NREL/SAM CONTRIBUTING.md for some ideas, especially the resources for using Git/GH section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mikofski