Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move xOpera's documentation back here #2

Closed
anzoman opened this issue Feb 12, 2021 · 0 comments · Fixed by #3
Closed

Move xOpera's documentation back here #2

anzoman opened this issue Feb 12, 2021 · 0 comments · Fixed by #3
Labels
enhancement New feature or request

Comments

@anzoman
Copy link
Contributor

anzoman commented Feb 12, 2021

Description

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.

Steps

We will need to delete all docs from xopera-opera here and move them here.

Current behaviour

The opera's docs are currently available on GitHub pages here: https://xlab-si.github.io/xopera-opera/.

Expected results

To have all documentation again in this repository.

Note

cc @cankarm, @sstanovnik

@anzoman anzoman added the enhancement New feature or request label Feb 12, 2021
anzoman added a commit that referenced this issue Apr 16, 2021
Within this commit we are bringing xOpera's documentation back here and
reasons why to do that are explained in #2.
anzoman added a commit that referenced this issue Apr 16, 2021
Within this commit we are bringing xOpera's documentation back here and
reasons why to do that are explained in #2.
anzoman added a commit that referenced this issue Apr 16, 2021
Within this commit we are bringing xOpera's documentation back here and
reasons why to do that are explained in #2.
anzoman added a commit that referenced this issue Apr 16, 2021
Within this commit we are bringing xOpera's documentation back here and
reasons why to do that are explained in #2.
cankarm pushed a commit that referenced this issue Apr 19, 2021
Within this commit we are bringing xOpera's documentation back here and
reasons why to do that are explained in #2.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant