DNNCommunity / DNNCommunity/DNNDocs
RFC: We need to build a Best Practices document in the Developers section
- Dominant language
- CSS
- Stars
- 24
- Forks
- 55
- PR merge metrics
- No merged PRs in 30d
Description
## Description of documentation change
We often talk about Best Practices that developers should follow, but that is not a very specific thing. Sometimes we refer to a blog post, sometimes a forum post, the old documentation, the wiki, etc. We cannot assume that developers have seen all that and a new developer will not go through all these various parts. We also used to have Dnn x.x.x Developer Quick Start series, that explained in details what changed in each release that affects development
## Existing documentation URL (if applicable)
Developer Quick Start Series:
https://www.dnnsoftware.com/wiki/dotnetnuke-6-developer-quick-start
https://www.dnnsoftware.com/wiki/dotnetnuke-61-developer-quick-start
https://www.dnnsoftware.com/wiki/dotnetnuke-62-developer-quick-start
https://www.dnnsoftware.com/wiki/dotnetnuke-70-developer-quick-start/page
https://www.dnnsoftware.com/wiki/dotnetnuke-7-1-developer-quick-start-draft
https://www.dnnsoftware.com/wiki/dnn-72-developer-quick-start
https://www.dnnsoftware.com/wiki/dnn-73-developer-quick-start
https://www.dnnsoftware.com/wiki/dnn-7-4-developer-quick-start
https://www.dnnsoftware.com/wiki/dnn-80-developer-quick-start
https://www.dnnsoftware.com/wiki/security-best-practices
https://www.dnnsoftware.com/wiki/performance-best-practices
https://www.dnnsoftware.com/wiki/module-development-best-practices
https://www.dnnsoftware.com/wiki/skinning-best-practices
## Existing documentation section (if applicable)
This would need to be discussed, I think Either a root Best Practices page with sub-sections for each subject, or under each persona (So administrators best practices, managers best parctices, developers best practices, etc.
## Additional context
I think we need to keep in mind the following when writing that:
- While researching on old best practices, we should try to delete the old content and put a link to the official new best practices document so that we have a single source of truth (and a single place to maintain).
- We should on each Dnn release collect some tags or release notes and regularly check if we need to advertise new best practices, we can refer people to docs in the release notes.
- I think a Developer Quick Start was nice to get up to date with what changed since the last best practices, but this cannot be the only thing, if we keep that, it should be an addition only to the merged best practices, we cannot expect new developer to go read all previous versions quick-starts.
- We need to collectively agree (maybe publishing drafts and showing them in the TAG meetings once in a while for approval). Many people might have different notions of what is best practices, we need a single voice when communicating this out.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.