clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-08-30 15:21:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
2,163 Commits 25 Branches 3 Tags
046cfd2bd2840efaf8bd046fbb7393e375cbcbbc
Commit Graph

41 Commits

Author SHA1 Message Date
Kristal Dale 1aa805dddc Minor revisions to structure-formatting and writing-guide (based on feedback) 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-23 13:18:15 -08:00
Kristal Dale 7f7841d40a - Correct typo in README 
- Add example/bullets to headlines section in writing guide

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-17 11:54:39 -08:00
Kristal Dale b099433b6c - Clean up indentation for examples. 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-16 17:24:25 -08:00
Kristal Dale 52b93d649e - white space correction 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-16 17:07:33 -08:00
Kristal Dale 7270dbe3e2 - Clean up remaining reference to mailing list 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-16 17:02:52 -08:00
Kristal Dale 7d70b47969 - Remove GitHub repo link from toctree 
- Reword description for use of :abbr:
- Simplify reference to mailing list

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-16 16:57:24 -08:00
MCamp859 b6db090cee Minor text edits for clarity. 
Signed-off-by: MCamp859 <maryx.camp@intel.com>
 2019-01-14 17:25:33 -05:00
Kristal Dale 0855e8ed8d Next round revisions: 
- alphabetize formatting table
- readd toctree to landing page, with alternate text
- line-length clean up
- add links to references available online
- misc cleanup

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-11 13:52:33 -08:00
MCamp859 52a6071097 Edited text. 
Signed-off-by: MCamp859 <maryx.camp@intel.com>
 2019-01-11 11:51:42 -05:00
Kristal Dale 88a09a22f6 Contribution guideline reorg and clean up 
- Reorg content into 3 pages for collab guides: overview (collaboration.rst),
structure and formatting, and writing guide.
- Simplify content, including removal of definitions/guidelines provided by
our listed resources, simplification of wording and examples.
- Add in quick ref section for our updated BKMs
- Update the README installation instructions
- Clarify different methods of contribution

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-01-08 13:33:25 -08:00
Kristal Dale 44fd806ade Update word in collab guide code section 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-11-08 10:29:34 -08:00
Kristal Dale 1e2b3fdfa4 Update product name substitution 
-Replace instances of CLOSIA substitution with CL-ATTR.
-Replace in-line use of Clear Linux with CL.
-Clean up white space.
-Limited clean up in collab section, in pref of future rework
-Set landing page toctree to use maxdepth 1

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-11-06 13:59:22 -08:00
Kevin Putnam 24cad8de93 fixed link to sphinx-doc.org 2018-10-25 11:32:51 -07:00
Michael Vincerra d2ffc5f8ae Revises parent toctree depth from 2 to 3; show embedded toctree, rest.rst. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-06 10:16:32 -07:00
Michael Vincerra a39a091926 Inserts missing spaces after code-block. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-03 10:38:10 -07:00
Michael Vincerra 5b39163851 Removes mod attempt from previous push. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-02 10:38:51 -07:00
Michael Vincerra 4cf7a21bc4 Adds URL for 'Sphinx documentation' close to its use. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-02 10:36:10 -07:00
Michael Vincerra ace4f38a59 Mod attempt to resolve reference to rest.rst, line 6 2018-08-02 09:26:04 -07:00
Michael Vincerra 7331b6d354 Confirms URI correct at bottom of page. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 17:34:29 -07:00
Michael Vincerra e6ea26dd82 Corrects URI, previously dead, and redirects to actual markup section. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 17:20:47 -07:00
Michael Vincerra af11db092a Fixes legacy error, extra line break, which broke URL. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 17:14:22 -07:00
Michael Vincerra 32d465787a Adds missing tick mark at end of include directive. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 17:08:57 -07:00
Michael Vincerra ab77c0c7a6 Add missing value for code-block in example. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 17:05:47 -07:00
Michael Vincerra e13738c0f5 Adds comparison of target and anchor, trad HTML usage. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 16:54:59 -07:00
Michael Vincerra 04055beee1 Describes actual use of include directive with use of targets. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-08-01 16:47:00 -07:00
Kevin Putnam ea4ce1a9e0 changed link and text 2018-08-01 09:29:58 -07:00
Kevin Putnam 288a3edd59 major edits to inline.rst including use of parsed-literal for rendered examples 2018-07-31 15:49:07 -07:00
Kevin Putnam 10aece4ee2 fixed overall formatting of inline.rst 2018-07-31 08:22:28 -07:00
Kevin Putnam ae25316714 added line break 2018-07-30 14:45:10 -07:00
Kevin Putnam ab15d98ddc Fixed the last of the warnings - not at zero 2018-07-30 14:25:56 -07:00
Kevin Putnam 0b08cf0cb0 first 23 fixes to remove warnings from build - down to 75 warnings 2018-07-23 16:25:15 -07:00
Michael Vincerra 4c818be239 Fixes typo. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-07-12 15:09:34 -07:00
Michael Vincerra a16acb9084 Corrects formatting. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-07-12 10:49:17 -07:00
Michael Vincerra 8cce36d61f Fixes format for contents: directive 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-07-12 10:41:51 -07:00
Michael Vincerra bdfa11846e Adds :contents: directive to Clear Linux collaboration guide. 
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2018-07-11 17:09:18 -07:00
Ecouzens 24ab40b3b4 copy edit and language update 
Signed-off-by: Ecouzens <evan.couzens@intel.com>
 2018-02-27 09:35:26 -08:00
Rodrigo Caballero f5f825b47f Add collaboration.rst to the Reference content toctree. 
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-12-12 16:47:44 -06:00
Rodrigo Caballero 9a876dd542 Fixed line length, typos, and minor markup issues. 
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-12-11 10:14:17 -06:00
Rodrigo Caballero b874bafdbb Fixed typos and removed unneeded content. 
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-11-30 15:56:57 -06:00
Rodrigo Caballero 76109e7d1a Improved the Basic contribution, Images, and Cross-reference sections. 
Added explicit instructions on how to contribute via GitHub, naming conventions
for all files, and explicit markup instructions for figures, links, and headings.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-11-30 15:28:30 -06:00
Rodrigo Caballero 1d7f1c2d14 Add documentation contribution guidelines. 
This section contains all the guidelines, rules, examples, and templates needed
to contribute content to the Clear Linux project. The mechanics on how to use
Git to contribute the content will be added in the future.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-09-13 10:58:30 -05:00