xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-12 08:10:12 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3149 from gurevichmark/spelling_docs_overview

Browse Source 
Spelling fixes for docs/sources/developers and overview
This commit is contained in:
Victor Hu
2017-05-30 21:19:19 -04:00
committed by GitHub
parent 50ec268c13 fda07616e5
commit 9bd0054d10
6 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/developers/github/change_code.rst
View File

@ -24,7 +24,7 @@ It may take days before your pull request is properly reviewed and you want to k
Creating additional branches will allow you to work on different tasks/enhancements at the same time. You can easily manage your working changes between branches with ``git stash.``.
Commiting code and pushing to remote branch
Committing code and pushing to remote branch
-------------------------------------------
Once your code is ready....

2
docs/source/developers/github/forks.rst
View File

@ -41,7 +41,7 @@ Configure an ``upstream`` repository
$ git remote add upstream git@github.com:xcat2/xcat-core.git
View the configured reposotories: ::
View the configured repositories: ::
$ git remote -v
origin git@github.com:<userid>/xcat-core.git (fetch)

2
docs/source/developers/github/pull_request.rst
View File

@ -65,7 +65,7 @@ During the reviewing of your pull request, another pull request may be merged wh
$ git push origin <mybranch> -f
If all the conflicts are resolved, the pull request should automaically turn green again and is able to be merged automatically.
If all the conflicts are resolved, the pull request should automatically turn green again and is able to be merged automatically.
Reviewing Pull Requests as a Maintainer
---------------------------------------

2
docs/source/developers/guides/code/builds.rst
View File

@ -37,7 +37,7 @@ The following steps will help configure ``pod2rst`` and be able to generate the
make
make install
* **[as non-root]** Extrat and build the Perl module using PREFIX to specify a directory that you have write permission ::
* **[as non-root]** Extract and build the Perl module using PREFIX to specify a directory that you have write permission ::
mkdir ~/perllib
perl Makefile.PL PREFIX=~/perllib

6
docs/source/developers/guides/docs/doc_guidelines.rst
View File

@ -65,7 +65,7 @@ Enumerated List
Include another file
--------------------
To add contents of a document file inside another file, use ``.. include::``. This is usefull when a common information needs to be displayed in multiple files, whithout the use of a hyperlink.
To add contents of a document file inside another file, use ``.. include::``. This is useful when a common information needs to be displayed in multiple files, without the use of a hyperlink.
::
.. include:: config_common.rst
@ -76,14 +76,14 @@ To add contents of a document file inside another file, use ``.. include::``. Th
Index file
----------
Index.rst files contain the ``.. toctree::`` tag. Files listed under that tag will have links to them displayed in the left side navigation area. If a documentation file does not wish to be accessbile from the navigation area, do not list it under the ``.. toctree::``.
Index.rst files contain the ``.. toctree::`` tag. Files listed under that tag will have links to them displayed in the left side navigation area. If a documentation file does not wish to be accessible from the navigation area, do not list it under the ``.. toctree::``.
``Note:`` If a file is not listed under the ``.. toctree::`` it might generate a warning during the documentation build ``WARNING: document isn't included in any toctree``. To eliminate such warning, add the file to the ``exclude_patterns`` list in the ``docs/source/conf.py`` file. However, do not add a file to the ``exclude_patterns`` list if it contains a customized link target, such as ``.. _my_link_taget:``. This link target will not be visible to other files and a ``WARNING: undefined label:`` will be displayed during the documentation build.
Hyperlinks -> Internal Links -> External Links
----------------------------------------------
Add links to refer other web page is a very common way in writting document, it's very helpful to reduce the doc duplication and make docs easy to understand. Following are several ways to add a link in the xCAT documentation.
Add links to refer other web page is a very common way in writing document, it's very helpful to reduce the doc duplication and make docs easy to understand. Following are several ways to add a link in the xCAT documentation.
* **Add an Internal Link to ``Customized Link Target``**

2
docs/source/overview/differentiators.rst
View File

@ -18,7 +18,7 @@ Differentiators
IBM Power, IBM Power LE, x86_64
* Support Multiple Virtulization Infrastructures
* Support Multiple Virtualization Infrastructures
IBM PowerKVM, KVM, IBM zVM, ESXI, XEN