Commit 56c85265 authored by Bob Obara's avatar Bob Obara

BUG: Fixing online information for CMB

parent 1dd328dc
......@@ -163,20 +163,20 @@ Our [wiki][] is used to document features, flesh out designs and host other
documentation. We have several [mailing lists][] to coordinate development and
to provide support.
[CMB Git README]: Documentation/dev/README.md
[developer instructions]: Documentation/dev/develop.md
[CMB Git README]: doc/dev/README.md
[developer instructions]: doc/dev/develop.md
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[Fork CMB]: https://gitlab.kitware.com/cmb/cmb/forks/new
[use SSH instead of HTTPS]: Documentation/dev/download.md#use-ssh-instead-of-https
[download instructions]: Documentation/dev/download.md#clone
[use SSH instead of HTTPS]: doc/dev/download.md#use-ssh-instead-of-https
[download instructions]: doc/dev/download.md#clone
[developer setup script]: Utilities/SetupForDevelopment.sh
[Setup]: Documentation/dev/develop.md#Setup
[Setup]: doc/dev/develop.md#Setup
[Build CMB]: https://gitlab.kitware.com/cmb/cmb-superbuild/
[Create a Topic]: Documentation/dev/develop.md#create-a-topic
[Share a Topic]: Documentation/dev/develop.md#share-a-topic
[Create a Merge Request]: Documentation/dev/develop.md#create-a-merge-request
[Review a Merge Request]: Documentation/dev/develop.md#review-a-merge-request
[review]: Documentation/dev/develop.md#review-a-merge-request
[Create a Topic]: doc/dev/develop.md#create-a-topic
[Share a Topic]: doc/dev/develop.md#share-a-topic
[Create a Merge Request]: doc/dev/develop.md#create-a-merge-request
[Review a Merge Request]: doc/dev/develop.md#review-a-merge-request
[review]: doc/dev/develop.md#review-a-merge-request
[Issues]: https://gitlab.kitware.com/cmb/cmb/issues
[Merge Requests]: https://gitlab.kitware.com/cmb/cmb/merge_requests
[Labels]: https://gitlab.kitware.com/cmb/cmb/labels
......@@ -185,4 +185,4 @@ to provide support.
[Mailing Lists]: http://www.computationalmodelbuilder.org/mailinglist/
[Gitlab Markdown]: https://gitlab.kitware.com/help/user/markdown.md
[new issue]: https://gitlab.kitware.com/cmb/cmb/issues/new
[Labels Glossary]: Documentation/dev/labels.md
[Labels Glossary]: doc/dev/labels.md
......@@ -10,11 +10,11 @@ has grown through collaborative efforts between [Kitware Inc.][Kitware],
and various other
government and commercial institutions, and acedemic partners.
[CMB]: http://www.ComputationalModelBuilder.org
[ParaView]: http://www.paraview.org
[CMB]: https://www.ComputationalModelBuilder.org
[ParaView]: https://www.paraview.org
[QT]: https://www.qt.io
[VTK]: http://www.vtk.org
[Kitware]: http://www.kitware.com
[Kitware]: https://www.kitware.com
Learning Resources
==================
......@@ -29,12 +29,12 @@ Learning Resources
are available from [Kitware][].
[CMB Homepage]: http://www.ComputationalModelBuilder.org
[Documentation]: http://www.computationalmodelbuilder.org/documentation/
[CMB Mailing Lists]: http://www.computationalmodelbuilder.org/mailinglist/
[Kitware]: http://www.kitware.com/
[Kitware Support]: http://www.kitware.com/products/support.html
[Kitware Training]: http://www.kitware.com/products/protraining.php
[CMB Homepage]: https://www.ComputationalModelBuilder.org
[Documentation]: https://www.computationalmodelbuilder.org/documentation/
[CMB Mailing Lists]: https://discourse.kitware.com/c/cmb
[Kitware]: https://www.kitware.com/
[Kitware Support]: https://www.kitware.com/products/support.html
[Kitware Training]: https://www.kitware.com/products/protraining.php
Reporting Bugs
==============
......
CMB Git Usage
==================
CMB version tracking and development is hosted by [Git](http://git-scm.com).
Please select a task for further instructions:
Main Tasks
----------
* [Install Git](http://public.kitware.com/Wiki/Git/Download) -
Git 1.7.2 or greater is preferred (required for development)
* [Download CMB](download.md) - Users start here
* [Develop CMB](develop.md) - Contributors start here
Other Tasks
-----------
* [Review Changes](https://gitlab.kitware.com/cmb/cmb/merge_requests) -
CMB GitLab Merge Requests
* [Learn Git](http://public.kitware.com/Wiki/Git/Resources) -
Third-party documentation
Branches
--------
The upstream CMB repository has the following branches:
* `master`: Development (default)
* `hooks`: Local commit hooks
([placed](http://public.kitware.com/Wiki/Git/Hooks#Local) in `.git/hooks`)
Labels
------
See [Labels](labels.md) for information on labels for Issues and Merge Requests.
This diff is collapsed.
Download CMB with Git
==========================
This page documents how to download CMB source code through [Git][].
See the [README](README.md) for more information.
[Git]: http://git-scm.com
Clone
-----
Optionally configure Git to [use SSH instead of HTTPS](#use-ssh-instead-of-https).
Clone CMB using the commands:
$ git clone --recursive https://gitlab.kitware.com/cmb/cmb.git CMB
$ cd CMB
Update
------
Users that have made no local changes and simply want to update a
clone with the latest changes may run:
$ git pull
$ git submodule update --init
Avoid making local changes unless you have read our [developer instructions][].
[developer instructions]: develop.md
Use SSH instead of HTTPS
------------------------
Git can be configured to access ``gitlab.kitware.com`` repositories through
the ``ssh`` protocol instead of ``https`` without having to manually change
every URL found in instructions, scripts, and submodule configurations.
1. Register for an account on [our GitLab instance][GitLab Access] and select a user name.
2. Add [SSH Keys][] to your GitLab account to authenticate your user via
the ``ssh`` protocol.
3. Configure Git to use ``ssh`` instead of ``https`` for all repositories
on ``gitlab.kitware.com``:
$ git config --global url."git@gitlab.kitware.com:".insteadOf https://gitlab.kitware.com/
The ``--global`` option causes this configuration to be stored in
``~/.gitconfig`` instead of in any repository, so it will map URLs
for all repositories.
4. Return to the [Clone](#clone) step above and use the instructions as
written. There is no need to manually specify the ssh protocol when
cloning. The Git ``insteadOf`` configuration will map it for you.
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[SSH Keys]: https://gitlab.kitware.com/profile/keys
Labels
======
[Labels][] are used to annotate [Issues][] and [Merge Requests][]. They help
organize and provide information about their state in the development
workflow.
Labels are named using the form `[category]:[name]`. Labels in the same category
has the same color.
`area:...`
------------
Labels in this category identify a component of CMB affected by the issue.
Current list includes `area:build`, `area:doc`, `area:installing`,
and `area:testing`.
Reporters and developers can assign these labels to an issue to help organize.
`priority:...`
--------------
An issue gets assigned a **Milestone** to indicate which release a fix for it
is planned for. The `priority:...` label can be used to indicate how critical is
this issue for that milestone.
| label | issues | merge requests | description |
| ----- | -------| -------------- | ----------- |
| `priority:critical` | x | | issue is a **critical regression** and may require a patch release (highest priority) |
| `priority:required` | x | | issue is **required** for a milestone (very high priority) |
| `priority:important` | x | | issue is **important** for a milestone but may be okay if missed |
| `priority:nice-to-have` | x | | issue is **nice-to-have**, but not critical or important |
| `priority:low` | x | | low priority issues for a particular milestone |
If an issue targeted for a milestone has no priority label, then it is assumed
to be `priority:low`.
`app:...`
---------------
These labels are associated with Issues to identify the CMB application associated with the issue. If the issue is related to the framework itself (hence it impacts all CMB-based applications) use `app:framework`.
`triage:...`
--------------
These labels can be assigned to Issues and Merge Requests to help triage as
indicated in the table below:
| label | issues | merge requests | description |
| ----- | -------| -------------- | ----------- |
| `triage:confirmed` | x | | issue has been confirmed by someone other than the reporter |
| `triage:crash` | x | | issue describes condition causing a crash |
| `triage:easy` | x | | added by developers to issues that are easy to fix |
| `triage:expired` | x | x | added to issues closed without resolving or merge requests closed without merging due to lack of activity |
| `triage:feature` | x | | issue is a feature request; can be added by developers or reporters |
| `triage:incorrect-functionality` | x | | issue refers to unexpected behavior; can be added by developers or reporters |
| `triage:needinfo` | x | x | on an open issue, this label is added to indicate that more information is needed from the reporter; on a closed issue, this label is added to indicate that more information is needed from the developer who closed the issue about how to test or review the issue; on a merge request this label is added to request more information from the developer before the merge request can be reviewed |
| `triage:merge-needs-work` | | x | added to merge requests after review if the reviewer deems it needs more work before it can be merged |
| `triage:pending-dashboards` | | x | added to merge requests that are awaiting dashboards before they can be reviewed or merged |
| `triage:ready-for-review` | | x | added to merge requests that are ready for review by a developer |
These labels may be removed if the issue or merge request is no longer in the
state indicated by the label. For example, a merge request gets a `triage:ready-for-review`
label to request another developer to review it. If the reviewer deems it needs
more work, he should add the `triage:needswork` label and remove the `triage:ready-for-review`
label since the latter is no longer applicable.
`workflow:...`
--------------
These labels are added to issues to indicate their state in the development cycle.
Similar to `priority:...`, there can only be at most one workflow label on an issue
at a time.
| label | issues | merge requests | description |
| ----- | -------| -------------- | ----------- |
| `workflow:active-developement` | x | | added to an open issue that is under development |
| `workflow:customer-review` | x | | added to a closed issue that is ready for review by the customer/reporter |
[Labels]: https://gitlab.kitware.com/cmb/cmb/labels
[Issues]: https://gitlab.kitware.com/cmb/cmb/issues
[Merge Requests]: https://gitlab.kitware.com/cmb/cmb/merge_requests
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment