... | @@ -76,6 +76,56 @@ After this, you find the list of available demo apps in the (generated) README f |
... | @@ -76,6 +76,56 @@ After this, you find the list of available demo apps in the (generated) README f |
|
Most demo apps require CII Services be running on your host or on another host => Check that the related CII Services (e.g. config service for a a config demo app) are accessible: see [How-to start/stop CII Services](#how-to-start-stop-cii-services)
|
|
Most demo apps require CII Services be running on your host or on another host => Check that the related CII Services (e.g. config service for a a config demo app) are accessible: see [How-to start/stop CII Services](#how-to-start-stop-cii-services)
|
|
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------
|
|
|
|
### ------------------------------------------------
|
|
|
|
--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
### Insufficent Manuals, Contributions
|
|
|
|
|
|
|
|
**Problem**
|
|
|
|
|
|
|
|
The information provided in the user manuals is incomplete, unclear, outdated, or misleading.
|
|
|
|
|
|
|
|
**Solution 1**
|
|
|
|
|
|
|
|
If you're not even really sure what you're looking for, go and [create a CII ticket](https://jira.eso.org/secure/CreateIssue!default.jspa), and we can help with the problem and hand, and discuss how to improve the documentation for others.
|
|
|
|
|
|
|
|
**Solution 2**
|
|
|
|
|
|
|
|
If you have a fairly clear idea what should be added to the manuals, you can propose and make changes to the documentation source files directly. Contributions are welcome!
|
|
|
|
|
|
|
|
The CII all-in-one User Manual is composed of a dozen sub-documents in reStructured text format (.rst). The only (minor) challenge is therefore to identify which sub-document you want to edit.
|
|
|
|
|
|
|
|
The documentation resides in `https://gitlab.eso.org/cii/info/cii-docs.git` that you can clone as usual to local workspace, then modify and create a merge request.
|
|
|
|
|
|
|
|
Alternatively, and recommended, you can edit the files directly in the browser by using the Web IDE built into gitlab:
|
|
|
|
|
|
|
|
1. Browse to https://gitlab.eso.org/cii/info/cii-docs
|
|
|
|
|
|
|
|
2. Press "Web IDE"
|
|
|
|
|
|
|
|
3. In the Web IDE's file tree (left),
|
|
|
|
* navigate to userManual/ciiman/src/docs
|
|
|
|
* find and select the .rst file, and make your changes
|
|
|
|
|
|
|
|
4. Commit (blue button on lower left),
|
|
|
|
* Leave the defaults (Create a new branch: YES, Start a new merge request: YES)
|
|
|
|
* Write commit message: please write some rationale for your contribution
|
|
|
|
|
|
|
|
5. Commit again (green button on lower left)
|
|
|
|
* Leave the defaults (Delete source branch on commit: YES)
|
|
|
|
|
|
|
|
6. Create Merge Request (blue button)
|
|
|
|
* wait for pipeline to finish, at which point Jenkins will add his comment,
|
|
|
|
* and in that comment follow the link under "Artifacts List" to see your change applied.
|
|
|
|
|
|
|
|
7. To refine the applied change, go back to step 2.
|
|
|
|
|
|
|
|
We'll check the merge request, and your change can make it to the next release.
|
|
|
|
|
|
|
|
Thanks in advance!
|
|
|
|
|
|
|
|
|
|
--------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------
|
|
### Failure to build ZPB from ICD \[ICD waf build\]
|
|
### Failure to build ZPB from ICD \[ICD waf build\]
|
|
|
|
|
... | | ... | |