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

Write Style Guide document for Project Trident documentation #6

Closed
Mrt134 opened this issue Aug 27, 2018 · 2 comments
Closed

Write Style Guide document for Project Trident documentation #6

Mrt134 opened this issue Aug 27, 2018 · 2 comments

Comments

Projects
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
@Mrt134
Copy link
Collaborator

@Mrt134 Mrt134 commented Aug 27, 2018

Create an outline and write a full document describing all style elements for Project Trident documentation.

@Mrt134 Mrt134 added this to To do in Trident Documentation via automation Aug 27, 2018
@Mrt134 Mrt134 self-assigned this Aug 27, 2018
@Mrt134
Copy link
Collaborator Author

@Mrt134 Mrt134 commented Aug 27, 2018

Working outline:

Title: Project Trident Documentation Style Guide
I. Introduction
  A. Goal of document
   1. License & copyright
   2. Single document to govern Trident documentation guidelines.
   3. Encourage contribution (organisation sets you free)
  B. Quick-start summary
   1. Adding markdown document to repo with a PR
   2. Review process overview
   3. Contribute translation
II. Documentation Tools and Publishing Process
  A. Documentation tools
   1. Hugo Static Site generator (Link)
   2. Markdown text (Link)
   3. Recommended editors or other tools (Kate, Geny, Igor, Markdown Magic, etc)
  B. Publish process
   1. Project Trident documentation files on GitHub
   2. Adding an article
   3. Build testing and automatic website refresh
   4. Statement of edit - contributions might be edited to conform to these style guidelines
III. Style and Usage
  A. General Document standards
   1. Date/time update
   2. Introduction section including goal of document and a quick start summary of the article (tl;dr)
   3. Voice and tone of the document
   4. Language
  B. Images & Tables
   1. Image standard usage and storage location
   2. Table standard syntax & practice
  C. Text style
   1. Punctuation
   2. Compound words
   3. Names and titles
   4. Abbreviations
   5. Numbers
   6. Quotations
  D. Markdown Syntax
   1. Standard syntax usage
   2. Custom syntax usage
IV. Translations
   1. Translation file location
   2. Translation tools
   3. Translation PR process

@Mrt134 Mrt134 moved this from To do to In progress in Trident Documentation Aug 27, 2018
Mrt134 added a commit that referenced this issue Sep 2, 2018
This is the first draft of the new Trident Style Guide. It needs review and possibly a table of contents with section links. We may also need to create a new subdirectory of /content to store this and other documentation articles.
beanpole135 added a commit that referenced this issue Sep 4, 2018
@Mrt134
Copy link
Collaborator Author

@Mrt134 Mrt134 commented Sep 13, 2018

There are a few updates needed to the initial style guide:

  • new trident-website/hugo-site/content/docs/ directory for this and other guides.
  • Explain the
+++
title = "Style Guide"
menutitle = "Style Guide"
description = "Start Here: Formatting and Quickstart Guide"
pre = "<i class='fa fa-font'></i>	"
+++

block at the beginning of each document.

Update this message with needed changes to the style guide.

Mrt134 added a commit that referenced this issue Feb 14, 2019
Added missing intro block for documentation articles.
Closes Issue #6
@Mrt134 Mrt134 closed this Mar 1, 2019
Trident Documentation automation moved this from In progress to Done Mar 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment