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

Clean up or rewrite FAQ #105

Open
mattias-p opened this issue Mar 24, 2020 · 2 comments
Open

Clean up or rewrite FAQ #105

mattias-p opened this issue Mar 24, 2020 · 2 comments
Assignees
Labels
A-Documentation Area: Documentation only.
Milestone

Comments

@mattias-p
Copy link
Member

mattias-p commented Mar 24, 2020

  • The FAQ should respect that a good part of its audience is non-technical.
  • Answers should generally be quite short. Details not fitting in an FAQ should be pruned.
  • The use of technical terms should be reviewed.
  • Links should use reference link syntax instead of inline link syntax.
  • Each sentence should start on new lines. (This helps maintenance e.g. by making diff outputs more readable.)
  • Long sentences should be line-wrapped to limit line widths.
  • Answers should be split into paragraphs where appropriate.
  • A narrative text (e.g. a blog post) describing Zonemaster should be based on removed materials.

These items were derived from review comments in #101.

@pamasse
Copy link
Contributor

pamasse commented Apr 26, 2020

@matsduf @sandoche2k Can you take a look on the no-technical part of the issue?
You can directly update the docs/FAQ/gui-faq-XX.md files

@sandoche2k
Copy link
Contributor

@pamasse we will focus on this for 2020.1

@matsduf matsduf modified the milestones: v2020.1, v2020.2 Sep 14, 2020
@ghost ghost mentioned this issue Nov 3, 2020
@matsduf matsduf modified the milestones: v2020.2, v2021.1 Feb 9, 2021
@matsduf matsduf modified the milestones: v2021.1, v2021.2 May 27, 2021
@matsduf matsduf modified the milestones: v2021.2, v2022.1 Dec 1, 2021
@matsduf matsduf modified the milestones: v2022.1, v2022.2 May 22, 2022
@matsduf matsduf modified the milestones: v2022.2, v2023.1 Dec 20, 2022
@matsduf matsduf modified the milestones: v2023.1, v2023.2 Jun 26, 2023
@matsduf matsduf modified the milestones: v2023.2, v2024.1 Mar 19, 2024
@matsduf matsduf modified the milestones: v2024.1, v2024.2 Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only.
Projects
None yet
Development

No branches or pull requests

4 participants