Skip to content

Commit

Permalink
doc: remove references to Gitlab
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippeCrassous committed Jun 22, 2021
1 parent 4a43b06 commit 77ba673
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 33 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,17 @@ Refer to the online documentation for details about current [features and limita

Documentation is available at the web site https://ubisoft-mixer.readthedocs.io/ to :

- [download and install](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/install.html),
- [download and install](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/install.html),
- [test](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/first-steps.html) locally,
- then [get connected](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/get-connected.html) and [work together](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/work-together.html)

## Updates

Updates are announced in the [mixer-addon Blender Chat](https://blender.chat/channel/mixer-addon) channel and as a Gitlab [announcement issues](https://gitlab.com/ubisoft-animation-studio/mixer/-/issues?label_name%5B%5D=Information).
Updates are announced in the [mixer-addon Blender Chat](https://blender.chat/channel/mixer-addon) channel.

## Support

The active support repository is on Gitlab https://gitlab.com/ubisoft-animation-studio/mixer.

The [Mixer Github repository](https://github.com/ubisoft/mixer) is a mirror that is part of Github [Ubisoft open source](https://github.com/ubisoft) projects group.
The active support repository is on the [Mixer Github repository](https://github.com/ubisoft/mixer) which is part of the [Ubisoft open source](https://github.com/ubisoft) projects group.

## Community

Expand Down
11 changes: 4 additions & 7 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,18 @@

## Repositories

The main repository is on Gitlab https://gitlab.com/ubisoft-animation-studio/mixer, please post your issues and merge requests there.
The main repository is on GitHub https://github.com/ubisoft/mixer, please post your issues and merge requests there.

On the Gitlab repository you can see the CI tasks running (linting, unit tests, packing the addon and releases) and you have access to clean releases on the dedicated page https://gitlab.com/ubisoft-animation-studio/mixer/-/releases.
On the Gitlab repository you can see the CI tasks running (linting, unit tests, packing the addon and releases) and you have access to clean releases on the dedicated page https://github.com/ubisoft/mixer/releases.

We do our development on both public Gitlab and an internal instance at Ubisoft. Mirroring is used to keep all repositories in sync (commits, tags and branches). We are slowly moving some important issues to the public repository to give more information to the community about our future developments and to open discussions.

We also have a mirror on Github https://github.com/ubisoft/mixer, as part of Ubisoft open source repositories.

## Contributing

You can [report any bug through issues on Gitlab](https://gitlab.com/ubisoft-animation-studio/mixer/-/issues). Please include the version you use in the issue and how to reproduce the bug, if possible. You can join a blender file, or a room file that you can save with the "Download Room" button in advanced room options.
You can [report any bug through issues on GitHub](https://github.com/ubisoft/mixer/issues). Please include the version you use in the issue and how to reproduce the bug, if possible. You can join a blender file, or a room file that you can save with the "Download Room" button in advanced room options.

In the code you might see references to VRtist or Shot Manager, which are other technologies / addons that are developed in our studio. Don't pay too much attention to related code since we plan to extract it in some way, probably with a plugins strategy.

You can [submit a merge requests on Gitlab](https://gitlab.com/ubisoft-animation-studio/mixer/-/merge_requests), but keep in mind that the architecture of the addon is likely to change significantly in the next few months. For bugfixes, simple refactoring, typos, documentation, or things related to the usage of the Blender API you can directly submit the merge request. For features please also open an issue to discuss it, so we can think about how it would fit in the future architecture.
You can [submit a pull requests on GitHub](https://github.com/ubisoft/mixer/pulls), but keep in mind that the architecture of the addon is likely to change significantly in the next few months. For bugfixes, simple refactoring, typos, documentation, or things related to the usage of the Blender API you can directly submit the merge request. For features please also open an issue to discuss it, so we can think about how it would fit in the future architecture.

If you have quick questions or want to chat with us, we have a channel on the Blender chat dedicated to this addon: https://blender.chat/channel/mixer-addon

Expand Down
20 changes: 2 additions & 18 deletions doc/unittest.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The scripts are located in a new `gitlab` folder.

You can skip tests by including the string `[skip-tests]` in the commit message.

### Interactive runner
### Interactive Gitlab runner

Documentation:

Expand All @@ -30,27 +30,11 @@ Installation steps:

1. Install a gitlab runner in a folder of your choice. For this tutorial we'll use `d:\gitlab_runner`.
2. Run a terminal as administrator, create folder `d:\gitlab_runner\working_dir` and place yourself into it in your terminal
3. Register a runner with `gitlab-runner-windows-amd64.exe register`. Use `https://gitlab-ncsa.ubisoft.org/` as URL, `3doSyUPxsy5hL-svi_Qu` as token, `blender` as tags, `shell` as executor. The token can be found in Settings -> CI/CD page of this repository. This step should create a file `config.toml` in `d:\gitlab_runner\working_dir`.
3. Register a runner with `gitlab-runner-windows-amd64.exe register`. Use `blender` as tag, `shell` as executor. The token can be found in Settings -> CI/CD page of this repository. This step should create a file `config.toml` in `d:\gitlab_runner\working_dir`.
4. Edit `d:\gitlab_runner\working_dir` and add an entry `cache_dir = "D:/gitlab_runner/cache"` in the `[[runners]]` section, after the `shell` entry.

Then run an interactive : `gitlab-runner-windows-amd64.exe run`. It must run as administrator because the `TSCON` command requires administrator rights to disconnect a session from the remote desktop.

As the runner executes jobs, it will display the jobs status :

```
D:\gitlab_runner>gitlab-runner-windows-amd64.exe run
Runtime platform arch=amd64 os=windows pid=19628 revision=4c96e5ad version=12.9.0
Starting multi-runner from D:\gitlab_runner\config.toml... builds=0
Configuration loaded builds=0
listen_address not defined, metrics & debug endpoints disabled builds=0
[session_server].listen_address not defined, session endpoints disabled builds=0
Checking for jobs... received job=11132741 repo_url=https://gitlab-ncsa.ubisoft.org/animation-studio/blender/mixer.git runner=Q-sQ1rhN
Job succeeded duration=5m3.2796891s job=11132741 project=39094 runner=Q-sQ1rhN
Checking for jobs... received job=11132866 repo_url=https://gitlab-ncsa.ubisoft.org/animation-studio/blender/mixer.git runner=Q-sQ1rhN
WARNING: Job failed: exit status 1 duration=5m8.5314355s job=11132866 project=39094 runner=Q-sQ1rhN
WARNING: Failed to process runner builds=0 error=exit status 1 executor=shell runner=Q-sQ1rhN
```

The builds for the runner will be put in the current working directory `d:\gitlab_runner\working_dir` where you started the runner.

### Runner as a Windows service
Expand Down
2 changes: 1 addition & 1 deletion docs/collaborate/get-connected.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Other VPN software
Mixer has been reported to work successfully with other VPN software:

* `Zerotier <https://www.zerotier.com/>`__
* `OpenVPN <https://openvpn.net/>`__ and `portmap.io <https://portmap.io/>`__ : some details in `this issue <https://gitlab.com/ubisoft-animation-studio/mixer/-/issues/23>`__
* `OpenVPN <https://openvpn.net/>`__ and `portmap.io <https://portmap.io/>`__ .



Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshoot/issue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Before reporting an issue, please make sure that are using the :ref:`latest vers
- the :ref:`faq <FAQ>`,
- restrictions in :ref:`synchronized` ,
- known problems in :ref:`caveats`,
- current Gitlab `issue list <https://gitlab.com/ubisoft-animation-studio/mixer/-/issues/>`_ .
- current GitHub `issue list <https://github.com/ubisoft/mixer/issues/>`_ .


If you think you have found a bug or would like to propose a new feature, please report an `issue <https://gitlab.com/ubisoft-animation-studio/mixer/-/issues>`_ on Gitlab.
If you think you have found a bug or would like to propose a new feature, please report an `issue <https://github.com/ubisoft/mixer/issues/>`_ on Gitlab.

Please consider attaching the Mixer log file:

Expand Down

0 comments on commit 77ba673

Please sign in to comment.