Commit Graph
30 Commits
Author SHA1 Message Date
Michael Vincerra e6b4f024ad Merge branch 'mv-about-architect' of https://github.com/mvincerx/clear-linux-documentation into development
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-03 19:44:57 -07:00
michael vincerra f8207916a3 Resolve rendering error in README. (#935)
* Resolve rendering error in README.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Removes hashes for steps.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Revise header level.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-22 10:57:14 -08:00
michael vincerra 912bb57255 Add virtualenv option for contributors in README. (#927)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise Makefile to enable make venv target and add instructions.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises README.md and root-level Makefile target `make venv`.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise venv target; revise README to simplify activation/deactivation.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise syntax to emph markdown rendering.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Fix formatting errors and make consistent ref to platforms.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-21 16:40:49 -08:00
michael vincerra 32e1b94030 Correct obsolete URL for contribution guidelines. (#897)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-11-05 16:33:38 -08:00
R Primus 9095e06aad https://github.com/clearlinux/clear-linux-documentation/issues/857: F… (#885)
* https://github.com/clearlinux/clear-linux-documentation/issues/857: Fix assorted typos

* Update for changes made since initial cloning of repository

* Fix case of word
2019-10-28 16:32:46 -07:00
Kevin Putnam 5a041baa1c Updated readme to reflect recent changes and latest doc BKMs. (#737)
* Updated readme to reflect recent changes and latest doc BKMs.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

* Fixes typo in subheader, Cleaning up.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-19 18:30:26 -07:00
Michael Vincerra 610efcc67a Test -mv 2019-09-13 11:56:55 -07: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 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
Rodrigo Caballero 1d583b2fb1 Fix repo link on clone command of README.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-12-12 16:18:44 -06:00
Rodrigo Caballero 34a0b6050f Restructure all technical content.
This restructure organizes the content into three sections, one per
technology. The content was left as untouched as possible, however
several directives needed to be standardized in order to implement the
new structure. All filenames follow use dashes-as-spaces and are written
using lower-case. Standard labels for files were implemented using the
filename as the label, thus, content can be cross-referenced without
having to open the file to see the label. Figures were moved to
decentralized folders to enable modularity. The scope of the restructure
as well as the dependencies between the changes required me to do it in
a single commit. Lastly, some cleanup had to be done for the
standardized structure to function properly.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2017-04-26 16:55:42 -05:00
Leona 86af3ff844 fix spacing issue on README
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 11:51:04 -07:00
Leona de7d9cbec4 fix spacing issue on README
Signed-off-by: Leona <leonax.cook@intel.com>
2016-10-05 11:49:36 -07:00
Leona c4049ed744 update link on README 2016-10-03 08:53:44 -07:00
Leona 6cdff123b4 update README 2016-10-03 08:52:24 -07:00
Leona 3891716c55 cleanup README 2015-11-23 08:02:15 -08:00
Leona e0f2e1d55f one more try to fix ref linkage in README 2015-11-18 07:41:12 -08:00
Leona f57f093f62 update README with jump-to section link fixed 2015-11-18 07:37:39 -08:00
Leona 42af65be62 update README with link to Sphinx Docs project 2015-11-18 07:32:52 -08:00
Leona 4be88534a6 update README 2015-11-18 07:29:54 -08:00
Leona 61baab7016 updating README; merge into master means one section of the README is conditional to when you cloned repo 2015-11-16 12:02:55 -08:00
Leona 54bd382d78 correcting code-block syntax to be consistent with the rest of the documentation 2015-11-16 11:25:09 -08:00
Leona ccfddb1c32 fixing files upstream to be able to merge 2015-11-16 10:51:48 -08:00
Leona be89cea6d9 adding reference detail and link to tips for formatting in .rst docs 2015-11-16 07:24:06 -08:00
Leona 158bc2f163 adding instructions for how to correct index 2015-11-16 07:14:06 -08:00
Leona 31e79e9b36 update typo 2015-11-16 06:41:42 -08:00
Leona e16fe932a2 fix typo and add external link to Sphinx doc. 2015-11-13 12:39:35 -08:00
Leona 6506a3f099 fix typo, add link to Sphinx 2015-11-13 12:37:26 -08:00
Leona 8edf3ebfa3 adding updated README 2015-11-13 12:32:01 -08:00
Simental Magana, Marcos 20263d6eb4 change file from MarkDown to rst to keep consistency. 2015-11-10 17:06:29 -06:00