xlab-si / xopera-docs Goto Github PK
View Code? Open in Web Editor NEWxOpera project documentation
Home Page: https://xlab-si.github.io/xopera-docs/
License: Apache License 2.0
xOpera project documentation
Home Page: https://xlab-si.github.io/xopera-docs/
License: Apache License 2.0
The opera's documentation is currently available on GitHub pages here: https://xlab-si.github.io/xopera-docs/.
If one looks at the documentation at the moment, he can get info on how to download and run opera TOSCA orchestrator, where opera is/has been used (EU projects), what is the purpose of the tool, past contributors, opera SaaS documentation and so on. This is all very nice but things can get better. I would recommend splitting our documentation into sensible sections where the user would find other information like:
This last line is very important for the newcomers and users that would want to help and contribute to opera. Since opera's source code can be complex to understand some times, we would need to have some kind of a roadmap that would lead programmers through the different parts of the code. I would also recommend that we modify README and and add a link to the docs there.
I believe that all this can and will make opera a lot more attractive to the new users.
We will need to modify rst files that are located in /docs
folder.
Opera has a documentation but it is far from being complete.
To have a more user friendly and informative documentation.
This issue was moved here from xlab-si/xopera-opera#121 because we moved all xOpera's docs bach to this repo (see #2).
https://xlab-si.github.io/xopera-docs/cli.html#quickstart is awesome. Unfortunately, it ends with no links to expand details what didn't fit into the intro.
Like how to set an output variable from a playbook. Had to go through all files to find that this is done through standard set_stats
Ansible module.
It would be nice to see more tutorials that gradually introduce TOSCA concepts for Ansible users and how do they play together. What immediately comes in mind.
Hello,
I was reading through the docs and identified some typos/ issues.
I am referring to https://github.com/xlab-si/xopera-docs/blob/790f7f2f177085897572fe5adde9d756a3c91fa0/docs/cli.rst in the following.
And a minor one:
content
, metadata and content
input has been renamend to marker
.Greetings ๐
This repository was first mentioned to be a central point for the xOpera's documentation that would contain the user's manual. Initially the documentation was created here and was served on GitHub pages at https://xlab-si.github.io/xopera-docs/. After some time we moved it to xopera-opera repository because at that time the documentation was targeting only the core parser and opera CLI. However, we also wanted to explain the whole xOpera ecosystem and all the connected tools so we realized that in this case the documentation does not fit in xopera-opera anymore and has to be either organized in every repository separately or moved back here. We decided for the latter option because maintaining documentation for different tools would be difficult. Moving the documentation here would also free xopera-opera repository because we wouldn't have to build docs there anymore and we could focus only on the orchestrator there and also the CI/CD will be faster.
We will need to delete all docs from xopera-opera here and move them here.
The opera's docs are currently available on GitHub pages here: https://xlab-si.github.io/xopera-opera/.
To have all documentation again in this repository.
cc @cankarm, @sstanovnik
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.