| Sep |
OCT |
Nov |
|
27 |
|
| 2019 |
2020 |
2021 |
About this capture
Web crawl data from Common Crawl.
The Wayback Machine - http://web.archive.org/web/20201027152319/https://github.com/apache/cloudstack-documentation
Skip to content
/;ref_cta:Sign up;ref_loc:header logged out">
Sign up
●
Features →
●Code review
●Project management
●Integrations
●Actions
●Packages
●Security
●Team management
●Hosting
●Mobile
●Customer stories →
●Security →
●
●
●
●Explore GitHub →
Learn & contribute
●Topics
●Collections
●Trending
●Learning Lab
●Open source guides
Connect with others
●Events
●Community forum
●GitHub Education
●GitHub Stars program
●
●
Plans →
●Compare plans
●Contact Sales
●Nonprofit →
●Education →
In this repository
All GitHub
↵
Jump to
↵
-
No suggested jump to results
{{ message }}
●
Watch
28
●
Star
8
●
Fork
47
Apache CloudStack Documentation
cloudstack.apache.org/
8
stars
47
forks
Star
Watch
●
Code
●
Pull requests
12
●
Actions
●
Security
●
Insights
More
●
Code
●
Pull requests
●
Actions
●
Security
●
Insights
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up
22
branches
7
tags
Go to file
Code
Clone
Use Git or checkout with SVN using the web URL.
Work fast with our official CLI.
Learn more.
●
Open with GitHub Desktop
●
Download ZIP
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio
If nothing happens, download the GitHub extension for Visual Studio and try again.
Latest commit
Git stats
●
229
commits
Files
Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
source
.gitignore
Makefile
README.rst
make.bat
README.rst
Apache CloudStack
Apache CloudStack is an Apache project, see <http://cloudstack.apache.org> for
more information.
Website
These guides can be viewed online at http://docs.cloudstack.apache.org/
Translation
Clean the build
make clean
Generate the .pot files
make gettext
Generate the .tx/config files with:
sphinx-intl update-txconfig-resources --pot-dir source/locale/pot --transifex-project-name apache-cloudstack-installation-rtd --locale-dir source/locale
Push the .pot files to transifex with:
tx push -s
Download the translated strings, for example Japanese (ja):
tx pull -l ja
Build the translated docs:
sphinx-intl build --locale-dir source/locale
make -e SPHINXOPTS="-D language='ja'" html
Feedback
Please send feedback to the mailing list at <dev@cloudstack.apache.org>,
or the JIRA at <https://issues.apache.org/jira/browse/CLOUDSTACK>.
Contributing to the documentation
Initial setup of your fork
In your browser, navigate to: https://github.com/apache/cloudstack-documentation
Fork this repository by clicking on the 'Fork' button on the top right hand side. The fork will happen and you will be taken to your own fork of the repository. On the right hand side of the page of your fork, under 'HTTPS clone URL', copy the URL to your clipboard by clicking the the clipboard just right of the URL.
On your computer, follow these steps to setup a local repository for working on the documentation:
$ git clone https://github.com/YOUR_ACCOUNT/cloudstack-documentation.git
$ cd cloudstack-docs-install
$ git remote add upstream https://github.com/apache/cloudstack-documentation.git
$ git checkout master
$ git fetch upstream
$ git merge upstream/master
Making changes
It is important that you create a new branch to make changes on and that you do not change the master branch (other than to pull in changes from upstream/master). In this case I will assume you will be creating a branch called dev to make your changes in. This dev branch will be created on your local repository and will then be pushed to your forked repository on GitHub where you will create a Pull Request for the changes to be committed into the official documentation.
It is good practice to create a new branch each time you want to contribute to the documentation and only track the changes for that pull request in this branch.
$ git checkout -b dev
(make your changes)
$ git add .
$ git commit -a -m "commit message for your changes"
Note
The -b specifies that you want to create a new branch called dev. You only specify -b the first time because you are creating a new branch. Once the dev branch exists, you can later switch to it with only git checkout dev.
Merging upstream/master into your dev branch
It is important that you maintain an up-to-date master branch in your local repository. This is done by merging in the upstream/master (the official documentation repository) into your local repository. You will want to do this before you start working on a feature as well as right before you submit your changes as a pull request. You can also do this process periodically while you work on your changes to make sure you are working off the most recent version of the documentation.
This process will do the following:
(一)Checkout your local master branch
(二)Synchronize your local master branch with the upstream/master so you have all the latest changes from the official docs
(三)Merge the latest changes from the official docs into your dev branch so it is up-to-date with the latest changes
$ git checkout master
$ git fetch upstream
$ git merge upstream/master
$ git checkout dev
$ git pull . master
Note
Now your dev branch is up-to-date with all the recent changes in the upstream/master.
Making a pull request on GitHub to contribute your changes
When you are happy with your changes and you want to contribute them, you will be creating a Pull Request on GitHub to do so. This is done by pushing your changes to your forked repository (usually called 'origin') and then initiating a pull request.
Note
Make sure you have merged upstream/master into your dev branch before you do this.
$ git push origin master
$ git push origin dev
Now that the dev branch has been pushed to your GitHub repository, you can initiate the pull request.
To initiate the pull request, do the following:
(一)Navigate your browser to your forked repository: https://github.com/YOUR_ACCOUNT/cloudstack-documentation
(二)Click the new button called 'Compare & pull request' that showed up just above the main area in your forked repository
(三)Enter a good description of the work you have done and then click 'Send pull request'
If you are requested to make modifications to your proposed changes, make the changes locally on your dev branch, re-push the changes and submit the pull request again.
Cleaning up after a successful pull request
Once the dev branch has been committed into the upstream/master branch, your local dev branch and the origin/dev branch are not needed anymore. If you want to make additional documentation changes, restart the process with a new branch.
Note
Make sure that your changes are in upstream/master before you delete your dev and origin/dev branches!
You can delete these deprecated branches with the following:
$ git checkout master
$ git branch -D dev
$ git push origin :dev
About
Apache CloudStack Documentation
cloudstack.apache.org/
Topics
python
java
cloudstack
cloud
Resources
Readme
7
tags
No packages published
+ 19 contributors
Languages
●
Python
76.9%
●
Batchfile
10.4%
●
Makefile
8.0%
●
CSS
4.7%
●© 2020 GitHub, Inc.
●Terms
●Privacy
●
●Security
●Status
●Help
●Contact GitHub
●Pricing
●API
●Training
●Blog
●About
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
We use optional third-party analytics cookies to understand how you use GitHub.com so we can build better products.
Learn more.
We use optional third-party analytics cookies to understand how you use GitHub.com so we can build better products.
You can always update your selection by clicking Cookie Preferences at the bottom of the page.
For more information, see our Privacy Statement.
Essential cookies
We use essential cookies to perform essential website functions, e.g. they're used to log you in.
Learn more
Always active
Analytics cookies
We use analytics cookies to understand how you use our websites so we can make them better, e.g. they're used to gather information about the pages you visit and how many clicks you need to accomplish a task.
Learn more
