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

Migrate "Documentation" #36

Merged
merged 2 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.DS_Store
.idea
.markdownlint.json

50 changes: 50 additions & 0 deletions docs/general-guidelines/documentation.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
# Documentation

## General

- In repository: what to include (depending on project type)
- Markup format: MD or Asciidoc
- Location: root of project
- README (what to include… template?) \[Policy\]
- Content \[Guidelines\] - [GitHub: Formatting your README](https://guides.github.com/features/wikis/#Formatting-a-readme)
- Project name
- Description
- Table of Contents (optional)
- Installation -> INSTALL
- Usage
- Requirements (runtime, dependencies)
- How to build
- How to run
- Contributing -> CONTRIBUTE
- Credits
- License -> LICENSE
- LICENSE \[Policy\]
- See ‘Code license section’
- INSTALL (what to include… template?)
- Content? \[Guidelines\]
- UPGRADE (what to include… template?)
- Content? \[Guidelines\]
- CHANGES / Release notes
- CONTRIBUTING - [GitHub: Setting guidelines for repository contributors](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors)
- We will make a general contributions guideline to include by default in all projects
- A custom contributions guideline document can be made, describing:
- Pull request policy
- Issues policy
- Branching model
- ..
- ..

## Design and project documentation

- Requirements & architecture design
- Roadmap

## End user documentation

- In what cases is it needed?
- Where
- Where/how can the user find it
- Where is it maintained (and how is it integrated)
- In what format

“Stand alone” documentation (in a broad sense, e.g. this handbook) should be
published under a CC-BY 4.0 licence (“Creative Commons - Attribution 4.0 International”).