clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-05-01 12:33:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
2,759 Commits 25 Branches 3 Tags
development
Commit Graph

53 Commits

Author SHA1 Message Date
Kevin Putnam
97cc3cfbbd Update landing page (#975) 
* 1. Updated landing page to emulate look and feel of docs page on clearlinux.org
2. Added Trademarks, Cookies, and Privacy Terms links to footer with some css formatting
3. Added some CSS to pre-emptively remove added formatting to definition list entries in sphinx/rtd theme in version 2 and above

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

* Added start/end for footer bullet list support

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

* 1. Hid toctree to reduce duplication.
2. Changed IRC link to match what is currently on the clearlinux.org site.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2020-01-06 15:50:59 -08:00
Kevin Putnam
112ec79c56 Added support for sphinx-tabs and created an example on the Stacks DB reference stack guide. (#928) 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-11-21 15:05:26 -08:00
Kevin Putnam
3bbc77a187 Removes Previous/Next buttons on each page of docs. (#846) 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-10-07 11:45:04 -07:00
Kristal Dale
d4529b126b Add custom 404 and 403 pages. (#841) 
- Added static html pages for 404 and 403 server responses.
- Added conf.py setting html_extra_path to copy static _errors folder
  with static 404/403 files into build output

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-10-04 09:38:41 -07:00
michael vincerra
da2334e3ab In top Makefile, adds venv target to use virtualenv: (#741) 
- Contributors may run `make venv` and install requirements.txt without modifying host OS
- Innermost `requirements.txt`, 2 dependencies, moved to uppermost requirements.txt
- Adds `venv` to .gitignore in case contributors/developer forget to remove.
- Reverts source/conf.py to original.
- Replaces python command with python3 in innermost _python/Makefile

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
 2019-09-22 21:06:08 -07:00
Kevin Putnam
6d763205d2 Added 简体中文 (Simplified Chinese) to language picker. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-09-09 14:30:50 -07:00
Kevin Putnam
bed3874cf3 Restores permalinks for all headers. (#746) 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-08-27 13:16:32 -07:00
Mary Camp
388228aa6b Edited conf.py to fix copyright statement. (#712) 
Signed-off-by: MCamp859 <maryx.camp@intel.com>
 2019-08-09 09:55:13 -07:00
Kristal Dale
3c3a1c3757 Minor revisions as part of transition to new location 
-Edits to about page (per request)
-Edits to landing page (per request)
-Moved bootable usb out of containing folder (unnecessary)
-Update conf future version name

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-08-06 16:01:05 -07:00
Kevin Putnam
c1b36ed13b Merge branch 'rtd-theme' of github.com:clearlinux/clear-linux-documentation into rtd-theme 2019-08-06 12:12:03 -07:00
Kevin Putnam
c6cf74e087 Fixed URLs for intall docs. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-08-06 12:10:22 -07:00
Kevin Putnam
9a52aa4866 Merge pull request #695 from intelkevinputnam/rtd-theme 
Tutorial rework per issue #688
 2019-08-06 11:27:29 -07:00
Kristal Dale
ae818da5d8 Added canonical tag configuration to config file. 
Added GA tracking snippet (cross-domain) to layout template.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-08-05 14:28:00 -07:00
Kevin Putnam
dda2e0a3bb Improved tutorials organization based on feedback. Added favicon to the project. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-08-05 14:04:16 -07:00
Kevin Putnam
759dd0b01a Removed specific references to Chinese and L19.01 in version picker. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-08-05 12:02:52 -07:00
Kristal Dale
c24e785a6b Add requirement and config for sphinx-sitemap 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-07-31 16:42:09 -07:00
Kevin Putnam
fabf2ad1db Added ping of publish URL and temp usage of collapsing sitenav nodes. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-25 16:08:59 -07:00
Kevin Putnam
8f958b598a Added /latest to top level URL for versions and languages switcher to reflect current hierarchy. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-25 12:12:37 -07:00
Kevin Putnam
6144c129f1 Removed unecessary langauges and LTS versions. Added .mo files to .gitignore. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-24 15:24:16 -07:00
Kevin Putnam
e36c86ed7e Small change to theme and added build of Chinese language version. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-22 14:10:10 -07:00
Kevin Putnam
6f2cfb1883 Missed English language first time around 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-15 08:15:47 -07:00
Kevin Putnam
289df47754 Quick fix to get languages and lts directories to work properly on intel gitlab instance. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-15 08:11:18 -07:00
Kevin Putnam
e3329bc2ca Added german language support and build for travis 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-12 13:36:15 -07:00
Kevin Putnam
31b519e901 Merge pull request #612 from krisdale/rtd-theme 
Initial commit for localization files
 2019-07-12 13:14:48 -07:00
Kristal Dale
337bff934b Revisions to Initial commit 
- Revised organization for .pot and .po files
- Added required plugin for Sphinx (sphinx-intl)
- Added sample German .po files for testing

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-07-12 12:54:50 -07:00
Kristal Dale
015470e7d6 Initial commit for localization files 
- new localization directory includes all .pot and .po files used in transaltions
- updated config to include sphinx-intl settings

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2019-07-11 15:45:32 -07:00
Kevin Putnam
77552f4a9f renamed support directories by adding leading "_" to differentiate from content. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-11 11:36:11 -07:00
Kevin Putnam
5687653508 Fixed problem with version and language paths. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-10 14:10:27 -07:00
Kevin Putnam
633f3d0194 in progress rtd theme improvements 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-07-09 15:05:31 -07:00
Kevin Putnam
7caea349e3 Additional proposed fixes to organization for RTD site. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-06-07 08:47:45 -07:00
Kevin Putnam
8a07199ef0 Removed superfluous layer from documentation hiearchy and renamed master doc from clear-linux.rst to index.rst to generate a cleaner url. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-06-06 12:26:58 -07:00
Kevin Putnam
8da654bea6 Improved layout and decided to avoid trying to create a full width header to avoid wasting screen space. 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
 2019-05-22 13:00:21 -07:00
Kevin Putnam
979f0c2979 experimenting with formatting 2019-05-07 09:44:31 -07:00
Kevin Putnam
5db336d01a fixed class conflict causing issue with comments in code blocks; fixed include caused by moving a file; changed top level of site to make it pretty; marked old index as orphan. 2019-04-03 12:49:01 -07:00
Kevin Putnam
41304dd834 added otc-tcs theme and clearlinux branding image 2019-02-07 13:42:52 -08:00
Kevin Putnam
37870481f8 changed branch to rtd-theme from master 2019-01-29 12:46:17 -08:00
Kevin Putnam
f536c008ee fixed edit with github 2019-01-29 12:42:59 -08:00
Kevin Putnam
5bc82f962c removed duplicate autproxy content, added edit on github, and embedded video 2019-01-29 12:39:43 -08:00
Kevin Putnam
61f07faaca changed documentation theme to read the docs 2018-11-13 10:20:32 -08:00
Kristal Dale
37811ae11f Update the official Clear Linux product name: 
- Substitutions
- Python config file
- Replace hard coded product name in page heading with sub on CL doc landing page
- Replace hard coded product name with sub in system-requirements

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
 2018-09-10 15:57:22 -07:00
Kevin Putnam
ab15d98ddc Fixed the last of the warnings - not at zero 2018-07-30 14:25:56 -07:00
Miguel Bernal Marin
b5f8fc33fd conf.py: fix warning on html_static_path 
A warning is showed when compiling the documentation:

WARNING: html_static_path entry '/home/git/clear-linux-documentation/source/_static' does not exist

After documentation restructure, the _static directory is no more needed.
This commit comment out html_static_path in config.py, and the warning
is not showed.
 2017-05-30 11:23:51 -05:00
Miguel Bernal Marin
cc14739d3b conf.py: fix html_add_permalinks 
When compiling documentation a warning message is showed:

WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'.

The documentation from http://www.sphinx-doc.org/es/stable/config.html
said to set it to None or the empty string to disable permalinks.

Now it is set to empty string and the warning disappear.
 2017-05-30 11:14:52 -05:00
Rodrigo Caballero
5a2b933e54 Fix substitutions warning. 
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2017-04-27 09:34:35 -05:00
Rodrigo Caballero
41cdf6ab0d Revert "Merge branch 'new-file-struct' into 'master'" 
This reverts commit 4d707bc539, reversing
changes made to b18458758e.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2016-11-22 10:56:24 -06:00
Rodrigo Caballero
a4b61aecf9 Modify file structure of docs source files. 
Changed the file structure to allow for easier and better maintenance of
the docs. Files were renamed as needed and following a consistent
convention. Added a index.rst to every folder allowing for partial
builds of the docs. Included content previously left out of the docs
build. The commit also performs minimal housekeeping.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2016-11-18 13:36:22 -06:00
Tullis, Michael L
720e0728cc Modifed conf.py file to update copyright to 2016. Fixed typo in gs_getting_started.rst. 2016-04-23 07:10:39 -06:00
Rodrigo Caballero
b561dbe189 Merge branch 'CLR-DOCS-THEME' into staging 
Merges the Docs theme brance with staging.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>

Conflicts:
	source/_themes/clearlinux/breadcrumbs.html
	source/_themes/clearlinux/footer.html
	source/_themes/clearlinux/header.html
	source/_themes/clearlinux/layout.html
	source/_themes/clearlinux/navigation.html
	source/_themes/clearlinux/static/css/main.css
	source/_themes/clearlinux/static/css/vendor/bootstrap-theme.min.css
	source/_themes/clearlinux/static/css/vendor/bootstrap.min.css
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Bold.woff
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-BoldItalic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Italic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Light.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Light.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Light.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Light.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Medium.woff
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.eot
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.svg
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-MediumItalic.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Regular.woff
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.eot
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.svg
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.ttf
	source/_themes/clearlinux/static/fonts/ClearSans-Thin.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Bd.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_BdIt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_It.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Lt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_LtIt.woff
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.eot
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.ttf
	source/_themes/clearlinux/static/fonts/IntelClear_WLat_Rg.woff
	source/_themes/clearlinux/static/images/favicons/favicon_android_192x192.ico
	source/_themes/clearlinux/static/images/favicons/favicon_android_192x192.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_114x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_114x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_120x120.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_120x120.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_144x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_144x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_152x152.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_152x152.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_180x180.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_180x180.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_57x57.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_57x57.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_60x60.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_60x60.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_72x72.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_72x72.png
	source/_themes/clearlinux/static/images/favicons/favicon_apple_76x76.ico
	source/_themes/clearlinux/static/images/favicons/favicon_apple_76x76.png
	source/_themes/clearlinux/static/images/favicons/favicon_microsoft_144x144.ico
	source/_themes/clearlinux/static/images/favicons/favicon_microsoft_144x144.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_16x16.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_16x16.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_32x32.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_32x32.png
	source/_themes/clearlinux/static/images/favicons/favicon_web_96x96.ico
	source/_themes/clearlinux/static/images/favicons/favicon_web_96x96.png
	source/_themes/clearlinux/static/js/project.js
	source/_themes/clearlinux/theme.conf
	source/conf.py
	source/index-openstack.rst
	source/index.rst
	source/index_bundles.rst
	source/index_gs.rst
	source/index_sw_update.rst
 2015-11-26 10:56:52 -06:00
Rodrigo Caballero
e909078db7 Add website theme to staging for testing. 
Adds the theme files developed by digital properties and modifies
the conf.py to use them. This will allow testing and collaboration.

Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
 2015-11-25 11:29:10 -06:00
Tullis, Michael L
74672780ba Adding componentized index files (per category) for proper navigation with new CSS. 2015-11-25 08:23:42 -07:00