Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • cloud/documentation
  • 242618/documentation
  • 469240/documentation
  • LukasD/documentation
  • 35475/documentation
  • 323969/documentation
6 results
Show changes
2-cli/images/app_creds_1.png

109 KiB

2-cli/images/app_creds_2.png

60.1 KiB

# How To Contribute
## Requirements
Working with our documentation requires the following tools:
* *git* for version control
* *nodejs* and *gitbook* for content management
This documentation is written in the *Markdown* markup language.
```bash
# Debian
apt-get install nodejs git
```
```bash
# CentOS
yum install nodejs git
```
```bash
# Fedora
dnf install nodejs git
```
Or see [NodeJS Documentation](https://nodejs.org/en/download/package-manager/) for distro-specific instructions.
## Work-flow Overview
1. Fork & clone repository
2. Create a branch
3. Commit your changes
4. Push to the branch
5. Create a Merge Request with the content of your branch
## Fork Repository
See [GitLab @ ICS MU](https://gitlab.ics.muni.cz/cloud/documentation/forks/new) for details. This will create your own clone of our repository where you will be able to make changes. Once you are happy with your changes, use GitLab to submit them to our original repository.
## Clone Repository
```bash
# after creating your own copy of the repository on GitLab
git clone git@gitlab.ics.muni.cz:${GITLAB_USER}/documentation.git
```
## Create New Branch
```bash
# in `documentation`
git checkout -b my_change
```
## Install GitBook
```bash
npm install gitbook-cli -g
# in `documentation`
gitbook install
```
This step MAY require `sudo` depending on your system and NodeJS installation method.
## Edit GitBook
```bash
# in `documentation`
gitbook serve
```
> Edits will be show live in your browser window, no need to refresh.
## Commit and Push Changes
```bash
git commit -am "My updates"
git push origin my_change
```
## Submit Changes
Create a *Merge Request* via [GitLab @ ICS MU](https://gitlab.ics.muni.cz/cloud/documentation/merge_requests/new).
# Frequently Asked Questions
## How do I register?
Follow instructions for registering in [MetaCentrum](https://metavo.metacentrum.cz/en/application/index.html).
## Where do I report a problem?
First, try to search documentation for an answer to your problem. If that does not yield results, open a
ticket with [cloud@metacentrum.cz](mailto:cloud@metacentrum.cz). When contacting user support, always
include your *username* (upper right corner of the web interface) and *domain* with
active *project* (upper left corner of the web interface) as well as a description of
your problem and/or an error message if available.
## Virtual Machine Instance
> TODO
## Security Group
> TODO
## Project
> TODO
## Floating IP Address
> TODO
## Image
> TODO
## Volume
> TODO
## SSH
> TODO
## SSH Key Pair
> TODO
# Introduction
This user guide aims to provide a basic walk-through of setting up your virtual infrastructure.
The left sidebar can be used for navigation throughout the documentation. The whole guide can also be downloaded
as PDFs for printing or later use.
If you are a beginner, we recommend starting in the [Quick Start](0-quick-start/README.md)
section which will take you step-by-step through starting your first virtual machine instance.
Advanced users should continue in the [Graphical User Interface](1-gui/README.md) or [Command Line Interface](2-cli/README.md)
sections, as these are more suitable for complex use cases and exploration of available features.
Frequently asked questions and corresponding answers can be found in the [FAQ](FAQ.md) section.
Please, consult this section before contacting user support.
Bear in mind that this is not the complete documentation to OpenStack but rather a quick
guide that is supposed to help you with elementary use of our infrastructure. If you need
more information, please turn to the official [OpenStack Documentation](https://docs.openstack.org/rocky/user/)
or contact user support and describe your use case.
* [Introduction](/README.md)
* [Quick Start](/0-quick-start/README.md)
* [Graphical User Interface](/1-gui/README.md)
* [Command Line Interface](/2-cli/README.md)
* [FAQ](/FAQ.md)
* [Contribute](/CONTRIBUTE.md)
* [Glossary](/GLOSSARY.md)
{
"title": "MetaCentrum Cloud - User Guide",
"description": "This guide aims to provide basic user manual for the user of MetaCentrum Cloud.",
"author": "The MetaCentrum Cloud Team <cloud@metacentrum.cz>",
"language": "en",
"plugins": [
"get-book",
"hints-istex",
"page-toc"
],
"pluginsConfig": {
"get-book": {
"url": "https://cloud.gitlab-pages.ics.muni.cz/documentation/mcc-user-guide.pdf",
"label": "Download as PDF"
},
"hints": {
"info": "fa fa-info-circle",
"success": "fa fa-check-circle",
"danger": "fa fa-exclamation-triangle",
"warning": "fa fa-exclamation-circle"
},
"page-toc": {
"selector": ".markdown-section h2, .markdown-section h3, .markdown-section h4",
"position": "top",
"showByDefault": true
}
}
}
{
"requires": true,
"lockfileVersion": 1,
"dependencies": {}
}