-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36 from clarin-eric/documentation
Migrate "Documentation"
- Loading branch information
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
.DS_Store | ||
.idea | ||
.markdownlint.json | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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”). |