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

Rework documentation structure #1315

Closed
dennissiemensma opened this issue Mar 6, 2021 · 2 comments
Closed

Rework documentation structure #1315

dennissiemensma opened this issue Mar 6, 2021 · 2 comments
Milestone
4.14

Comments

@dennissiemensma
Copy link
Member

Momenteel is de documentatie redelijk uitgewerkt. Echter, ik merk dat het moeilijk is om er een goede structuur in te maken. Het is namelijk deels promotie van features, deels FAQ/zelfhulp, deels handleidingen en ik merk dat het soms wat lastig is om daar een natuurlijke indeling in te maken.

Een tijdje terug kwam ik deze tegen en dat is superinteressant, namelijk gewoon de documentatie splitsen in vier categorieen:
https://documentation.divio.com/

  • Tutorials
  • How-to
  • Explanation
  • Reference

Moeite waard om wat tijd in te steken. Ik denk dat het uiteindelijk de gebruikers goed kan helpen.
@jeroenpeters1986
Copy link
Collaborator

jeroenpeters1986 commented Mar 6, 2021 via email

This was referenced Mar 6, 2021
Closed
Closed
dennissiemensma added a commit that referenced this issue Mar 11, 2021
@dennissiemensma
Initial setup for documentation overhaul #1315
9e2bd81
dennissiemensma added a commit that referenced this issue Mar 11, 2021
@dennissiemensma
Moved docs locale dir #1315
338ecbf
dennissiemensma added a commit that referenced this issue Mar 11, 2021
@dennissiemensma
Fixed broken references in docs #1315
9bf93ff
dennissiemensma added a commit that referenced this issue Mar 12, 2021
@dennissiemensma
Fixed missing doc translations #1315
db01232
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Fixed doc redirects #1315
86617f1
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Update doc redirect #1315
f516e0a
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Fixed nested doc redirects #1315
ffd3ffd
@dennissiemensma dennissiemensma added this to the 4.14 milestone Mar 13, 2021
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Fixed doc translation header clearer #1315
d7eb96e
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Fixed doc translation header clearer #1315
f5efd53
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Fixed doc translation #1315
e1d234e
dennissiemensma added a commit that referenced this issue Mar 13, 2021
@dennissiemensma
Reworked docs and translations a bit #1315
d0a219a
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Readme update #1315
613aefa
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Splitted FAQ #1315
6f0749a
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Fixed doc references #1315
86b4384
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Fixed doc translations spacing #1315
ff04ea1
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc references are now absolute #1315
de4cb1e
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc redirects are now absolute #1315
c49e02b
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc redirects are now absolute #1315
029799f
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc redirects only work with relative paths #1315
373a801
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Fixed typo in doc redirects #1315
243710c
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Updated screenshots #1315
3ae78e2
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Updated about docs #1315
ae5af0c
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Renamed explained section #1315
422cec6
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation update #1315
13e11fd
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation update #1315
cf4967c
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation update #1315
d5f6550
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation fix #1315
97cdfec
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation fix #1315
53fea6a
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc translation fix #1315
03575fd
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc updates #1315
222ec98
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc updates #1315
7e942f5
dennissiemensma added a commit that referenced this issue Mar 14, 2021
@dennissiemensma
Doc references #1315
3e88dc3
@dennissiemensma
Copy link
Member Author

Eerste opzet staat. Zal wel wat iteraties nodig hebben voordat het optimaal is.

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
4.14
Development

No branches or pull requests
2 participants
@jeroenpeters1986 @dennissiemensma