First commit

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2026-08-24 16:57:45 +00:00 · 2019-07-29 14:35:12 -07:00
1353 changed files with 352345 additions and 52016 deletions
@@ -0,0 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
 config: cc99ba4fd98ddc62c1fab24f336360f5
 tags: 645f666f9bcd5a90fca523b33c5a78b7
@@ -1,22 +0,0 @@
 ---
 name: Modify document
 about: Modify a document for the Clear Linux* Project
 title: ''
 labels: P2
 assignees: ''
 ---
 **Describe the error/improvement to an existing document or image**
 Provide a clear and concise description of the error or proposed improvement.
 **Screenshots**
 If applicable, add screenshots to help explain the error or unexpected behavior.
 **Environment (please complete the following):**
 - Clear Linux OS version: [`cat /usr/lib/os-release`]
 - Third-party tool/software: [version]
 - Command [ [e.g. `sudo -i`]
 **Additional context**
 Add any other context about the problem here.
@@ -1,20 +0,0 @@
 ---
 name: New document
 about: Request a new document for the Clear Linux* project
 title: ''
 labels: P2
 assignees: ''
 ---
 **Do you think Clear Linux documentation needs a new document? Please describe.**
 Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User.
 **Should the new document be a guide, a reference, or a tutorial?**
 Recommend a type of document, based on the structure here: https://clearlinux.org/documentation/clear-linux
 **Describe or provide examples of similar documents, if possible, from other web sites**
 Please provide an example of similar documents if possible.
 **Additional context**
 Add any other context or screenshots for the document request here.
@@ -1,13 +0,0 @@
 name: Greetings
 on: [pull_request, issues]
 jobs:
  greeting:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/first-interaction@v1
      with:
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        issue-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first issue.'
        pr-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first PR.'
@@ -1,19 +0,0 @@
 #Exluding from the tree the html build files
 source/_build
 # ignore vi temporary files
 *.swp
 *~
 .*~
 # ignore VS code settings
 .vscode/
 # ignore .mo translation files
 *.mo
 # ignore artifacts generated by running make py
 cloned_repo
 bundles.html.txt
 # ignore the venv, used for running make py
 venv
@@ -1,19 +0,0 @@
 image: alpine
 pages:
  script:
  - apk --no-cache add python3
  - python3 -m ensurepip
  - pip3 install sphinx==1.8.0 docutils==0.14 sphinx_rtd_theme breathe==4.9.1 sphinxcontrib-plantuml sphinx-intl==2.0.0 sphinx-sitemap==1.0.2
  - apk --no-cache add make
  - apk --no-cache add doxygen
  - apk --no-cache add graphviz
  - apk --no-cache add ttf-dejavu 
  - apk --no-cache add openjdk8-jre
  - make htmlall
  - mv source/_build/html/ public/
  artifacts:
    paths:
    - public
  only:
  - rtd-theme
@@ -1,54 +0,0 @@
 language: python
 python:
  - "3.6"
 # command to install dependencies
 install:
  - pip3 install -q -r requirements.txt
 # command to run tests
 script:
  - make py
  - make htmlall
 before_deploy:
  - make linkcheck
  # only deploy the latest tagged release of Simplified Chinese docs
  - wget https://github.com/clearlinux/clear-linux-documentation-zh-CN/releases/latest/download/clearlinux-docs-zh-CN.tar.gz
  - mkdir source/_build/html/zh_CN
  - tar xvzf clearlinux-docs-zh-CN.tar.gz -C source/_build/html/zh_CN
 deploy:
  - provider: pages
    skip_cleanup: true
    github_token: $GITHUB_TOKEN
    target-branch: latestHTML
    on:
      branch: publish
    local_dir: source/_build/html/
  - provider: pages
    skip_cleanup: true
    github_token: $GITHUB_TOKEN
    target-branch: developmentHTML
    on:
      branch: master
    local_dir: source/_build/html/
  - provider: pages
    skip_cleanup: true
    github_token: $GITHUB_TOKEN
    target-branch: developmentHTML
    on:
      branch: development
    local_dir: source/_build/html/
  - provider: releases
    skip_cleanup: true
    api_key: $GITHUB_TOKEN
    file: clearlinux-docs-zh-CN.tar.gz
    on:
      tags: true
 after_deploy:
  - wget $PUBLISH_URL
  - cat clearlinux-latest
@@ -1,39 +0,0 @@
 # Makefile for Sphinx documentation
 SHELL := /bin/bash
 PY_VERSION ?= 3.6
 all:
 	make -C source html
 htmlall:
 	make -C source htmlall
 htmlzh:
 	make -C source htmlzh
 htmlde:
 	make -C source htmlde
 html:
 	make -C source html
 linkcheck:
 	make -C source linkcheck
 py:
 	make -C source py
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
 clean:
 	make -C source clean
 	rm -rf venv
 venv:
 	virtualenv venv;\
 	source venv/bin/activate; \
 	pip3 install -r requirements.txt;
@@ -1,184 +0,0 @@
 Documentation build instructions
 ################################
 .. todo add comment re not using standards here.
 `Clear Linux\* OS documentation`_ is written using `reStructuredText`_ and
 built using `Sphinx`_. Follow the instructions in this README to build the
 documentation locally for development and testing.
 Please make yourself familiar with our `contribution guidelines`_ before
 submitting a contribution.
 Clone the documentation repository
 **********************************
 Clone the documentation repository to your local machine.
 .. code-block:: bash
   git clone https://github.com/clearlinux/clear-linux-documentation
 Requirements
 ************
 Make sure you have Python 3 installed to start.
 The Sphinx documentation provides `instructions for installing Sphinx`_
 on various platforms.
 Use pip3 to install additional Python dependencies listed in the
 requirements.txt file found in the repository:
 .. code-block:: bash
   pip3 install -r requirements.txt
 Run the build
 *************
 We build our documentation using Sphinx. In the source directory of your
 local clear-linux-documentation repository, preview changes to the
 documentation by building the docs in the default language (English) by
 running ``make html``:
 .. code-block:: bash
   make html
 .. code-block:: console
   sphinx-build -b html -d _build/doctrees   . _build/html
   Running Sphinx v1.8.0
   making output directory...
   .
   .
   .
   build succeeded, 0 warnings.
   The HTML pages are in _build/html.
   Build finished. The HTML pages are in _build/html.
 Open one of the HTML pages found in ``source/_build/html`` in a web browser
 to view the rendered documentation.
 If you want to build the documentation exactly as seen on the website, use
 ``make py`` followed by ``make htmlall``. This builds some
 external dependencies and all supported languages.
 Use virtualenv 
 **************
 To develop documentation in a ``virtualenv``, use the ``venv`` target.
 The Clear Linux OS documentation make target ``venv`` provides a 
 simple development environment that ensures that you have the 
 latest packages and that you manage Python versions separately. Use of the 
 ``virtualenv`` requires **Python 3.6** or higher. For Windows examples below, use Powershell as an Administrator.
 The **virtual environment** uses the same version of Python that was used to **create the virtual environment**. 
 Verify ``pip`` is installed. A file path to pip should appear. 
 On Clear Linux OS and macOS\*:
 .. code-block:: bash
   which pip
 On Windows\* 10 OS: 
 .. code-block:: bash
   pip --version
 If ``pip`` is not installed, install it. 
 On Clear Linux OS and macOS:
 .. code-block:: bash
   python3 -m pip install --user --upgrade pip
 On Windows 10 OS: 
 .. code-block:: bash
   py -m pip install --upgrade pip
 .. note::
   This assumes Python was already added to your Windows path. 
 Install virtualenv 
 ==================
 Install ``virtualenv``. 
 On Clear Linux OS and macOS\*:
 .. code-block:: bash
   python3 -m pip install --user virtualenv
 On Windows 10 OS: 
 .. code-block:: bash
   py -m pip install --user virtualenv
 Create the ``virtualenv`` and install the required packages: 
 .. code-block:: bash
   make venv
 Activate the ``venv``. 
 .. code-block:: bash
   source venv/bin/activate
 Follow `Run the build`_ section to start developing documentation.
 Remove the ``venv`` when finished developing.  
 .. code-block:: bash
   deactivate
 Additional help
 ***************
 Cleaning up
 ===========
 When testing changes in the documentation, make sure to remove the previous
 build before building again by running ``make clean``:
 .. code-block:: bash
   make clean
 This will completely remove the previous build output, including artifacts 
 from the `make venv` target when done outside an active venv.
 Convenience script
 ==================
 This bash script (Linux only) includes both ``make clean`` and
 ``make html``. It also starts a simple Python web server that
 displays a preview of the site at http://localhost:8000 on your local machine.
 .. code-block:: bash
   ./checkwork.sh
 To stop the web server simply use ``ctrl-c``.
 .. _Clear Linux\* OS documentation:  https://docs.01.org/clearlinux/
 .. _Sphinx: http://sphinx-doc.org/
 .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
 .. _contribution guidelines: https://docs.01.org/clearlinux/latest/collaboration/collaboration.html
 .. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
--- a/Show More
+++ b/Show More