Where to put what content
- Sander Jansen
In order to prevent confusion, here are some guidelines on where to put what information.
DRAFT
We currently use:
Wiki (end-user documentation)
Github issues (in every repositories)
Github discussions (every repositories)
ADR's
LF energy Confluence
Readme.md (in every repository)
Youtube tutorials
Acceptance critria:
Proposal: Where to locate what
Disable unwanted documentation locations
Future plan
| Subject | Where to store it |
|---|---|
| Feature requests | Issues · openscd/open-scd (github.com) |
| Questions | Issues · openscd/open-scd (github.com) |
| Bug reports | Issues · openscd/open-scd (github.com) |
| Technical discussions | openscd/open-scd · Discussions · GitHub |
| Repository describtion and technical documentation related to to the repository | Repository (e.g. readme.md) |
| Architectural decisions | open-scd/docs/decisions at main · openscd/open-scd (github.com) |
| Way of working | LF energy confluence |
| Community improvement points | Issues · openscd/open-scd (github.com) |
| Meeting notes | LF energy confluence |
| End-user documentation | Home · openscd/open-scd Wiki (github.com) |
| Video's | LF energy youtube channel (ask Dan Brown) |
| Chat | lfenergy.slack.com |
| Roadmap | |
Todo
Disable the wiki and issues all repositories expect: openscd/open-scd: A substation configuration description editor for projects using SCL IEC 61850-6 Edition 2 or greater (github.com)
Move openscd/.community (github.com) to openscd github issues
openscd/.github remove ADR's and history and move it to open-scd repository
Issues · openscd/openscd.github.io
Update Readme.md:
Remove:
Kanban board · [Deprecated] Migration Plan - OpenSCD Core (github.com)