Documentation - Revision history

Mri083: Starting new page for software structure

2021-03-17T11:28:12Z

Starting new page for software structure

← Older revision		Revision as of 11:28, 17 March 2021
Line 7:		Line 7:
	* General mailing list: pCT@uib.no		* General mailing list: pCT@uib.no
	* [https://pctbergen.slack.com Slack project]		* [https://pctbergen.slack.com Slack project]

			== [[Software structure]] ==

	== Software installation ==		== Software installation ==

Mri083: /* Software installation */ adding entry for a new section "Docker containers"

2021-02-19T14:39:23Z

Software installation: adding entry for a new section "Docker containers"

← Older revision		Revision as of 14:39, 19 February 2021
Line 27:		Line 27:
	*: http://www.vtk.org/		*: http://www.vtk.org/
	*: https://github.com/Kitware/VTK		*: https://github.com/Kitware/VTK
			* [[Docker containers]]

	== Software repositories ==		== Software repositories ==

Mri083: a few minor clarifications

2021-02-19T14:37:25Z

a few minor clarifications

← Older revision		Revision as of 14:37, 19 February 2021
Line 1:		Line 1:
	[[Main Page]] -> [[Documentation]]		[[Main Page]] -> [[Documentation \| Software Documentation]]

			This is the landing page for software documentation, installation instructions, the development workflow, etc.

	== Mailing lists and collaborative tools ==		== Mailing lists and collaborative tools ==
	* Project web page: ~~has to come~~		* Project web page: [https://www.uib.no/en/ift/142356/medical-physics-bergen-pct-project https://www.uib.no/en/ift/142356/medical-physics-bergen-pct-project]
	* General mailing list: pCT@uib.no		* General mailing list: pCT@uib.no
	* [https://pctbergen.slack.com Slack project]		* [https://pctbergen.slack.com Slack project]
Line 26:		Line 28:
	*: https://github.com/Kitware/VTK		*: https://github.com/Kitware/VTK

	== Software ~~repository~~ ==		== Software repositories ==
	We use the '''GitLab''' service hosted by IT of University of Bergen: [https://git.app.uib.no/ https://git.app.uib.no/]		We use the '''GitLab''' service hosted by IT of University of Bergen: [https://git.app.uib.no/ https://git.app.uib.no/]

Line 41:		Line 43:
	Guest accounts for external developers can be set up, get in contact with the group over the general [[Documentation#Mailing lists and collaborative tools \| channels]]		Guest accounts for external developers can be set up, get in contact with the group over the general [[Documentation#Mailing lists and collaborative tools \| channels]]

	Further information on the ~~GitLab documentation~~ webpages:		Further information on GitLab in general can by found on the following external webpages:
	* [https://docs.gitlab.com/ce/gitlab-basics/README.html Gitlab basics]		* [https://docs.gitlab.com/ce/gitlab-basics/README.html Gitlab basics]
	* [https://docs.gitlab.com/ee/workflow/README.html Gitlab workflow]		* [https://docs.gitlab.com/ee/workflow/README.html Gitlab workflow]

	<br>		<br>
	~~For further reading pick one of~~ the ~~topics below~~:		The specific instructions how to use the repositories within the pCT project are collected in the following pages:
	==== [[GitLab best practice]] ====		==== [[GitLab best practice]] ====
	==== [[GitLab Developer FAQ]] ====		==== [[GitLab Developer FAQ]] ====

Mri083: /* Getting the code */ typo fixed

2021-02-10T14:04:50Z

Getting the code: typo fixed

← Older revision		Revision as of 14:04, 10 February 2021
Line 52:		Line 52:

	== Getting the code ==		== Getting the code ==
	If you simply ed the code, you can download an archive from the GitLab web interface. However, if there is a tiny chance that you might start developing, the recommended way is to clone the repository. See [[GitLab best practice#Roles]].		If you simply need the code, you can download an archive from the GitLab web interface. However, if there is a tiny chance that you might start developing, the recommended way is to clone the repository. See [[GitLab best practice#Roles]].

	== Development workflow ==		== Development workflow ==

Mri083: /* Get access to the repositories - without UiB account */

2021-02-10T13:58:31Z

Get access to the repositories - without UiB account

Mri083: /* Software repository */

2021-02-10T13:54:51Z

Software repository

← Older revision		Revision as of 13:54, 10 February 2021
Line 27:		Line 27:

	== Software repository ==		== Software repository ==
	We use the '''~~gitlab~~''' ~~server~~ hosted by IT of University of Bergen.		We use the '''GitLab''' service hosted by IT of University of Bergen: [https://git.app.uib.no/ https://git.app.uib.no/]

	=== Get access to the repositories - with UiB account ===		=== Get access to the repositories - with UiB account ===

Mri083: /* Development workflow */ updating links and removing content moved to GitLab developer FAQ

2021-02-10T13:46:22Z

Development workflow: updating links and removing content moved to GitLab developer FAQ

← Older revision		Revision as of 13:46, 10 February 2021
Line 50:		Line 50:

	==== [[Gitlab Master FAQ]] ====		==== [[Gitlab Master FAQ]] ====

			== Getting the code ==
			If you simply ed the code, you can download an archive from the GitLab web interface. However, if there is a tiny chance that you might start developing, the recommended way is to clone the repository. See [[GitLab best practice#Roles]].

	== Development workflow ==		== Development workflow ==
	Every logged-in user can access the main repository, however only a small group of administrators has write access. To contribute, a user creates a '''fork''' ~~(see [[Documentation#Creating_a_project_fork \| here]])~~ from the repository. This is a repository copy in the ~~Gitlab~~ system where a single developer or a group of developers have full access.		Every logged-in user can access the main repository, however only a small group of administrators has write access. To contribute, a user creates a '''fork''' from the repository. This is a repository copy in the GitLab system where a single developer or a group of developers have full access, see [[GitLab Developer FAQ#Working with forks]].

	~~A local copy of the repository is required on the working machine in order to work on the project. This copy is referred to be a '''clone''' (~~see [[~~Documentation~~#~~Making_local_working_copy \| here~~]]).

	~~=== Pushing to development fork ===~~
	~~Once you have added commits to e.g~~. ~~the '''dev''' branch, those commits can be ''pushed'' upstream to the fork (if ''origin'' refers to the fork)~~
	~~git push origin dev~~

	~~Or using~~ the ~~direct link~~		A local copy of the repository is required on the working machine in order to work on the project. This copy is referred to be a '''clone''', see [[GitLab Developer FAQ#How can I make a clone of a project in my fork]].
	~~git push https://user@gitlab.uib~~.~~no/user/wpn~~.~~git dev~~

	== User documentation ==		== User documentation ==

Mri083: /* Importing an external package */ moved to GitLab master FAQ

2021-02-10T10:24:39Z

Importing an external package: moved to GitLab master FAQ

@@ Line 62: / Line 62: @@
 Or using the direct link
      git push https://user@gitlab.uib.no/user/wpn.git dev
 == User documentation ==

Mri083: /* Making local working copy */ moved to GitLab developer FAQ

2021-02-10T10:22:05Z

Making local working copy: moved to GitLab developer FAQ

← Older revision		Revision as of 10:22, 10 February 2021
Line 55:		Line 55:

	A local copy of the repository is required on the working machine in order to work on the project. This copy is referred to be a '''clone''' (see [[Documentation#Making_local_working_copy \| here]]).		A local copy of the repository is required on the working machine in order to work on the project. This copy is referred to be a '''clone''' (see [[Documentation#Making_local_working_copy \| here]]).

	~~=== Making local working copy ===~~
	A project is utilized through a local working copy referred to be a ''clone''. The project can be cloned from either the main repository in the group space or the fork in the user space depending on the role.

	~~In the examples replace ''user'' and ''wpn'' (e.g. wp7) appropriately.~~

	~~'''Note''': the gitlab offers two modes for the link to be cloned, you can choose ''ssh'' (default setting) or ''https''. If you can not clone with the proposed default link, try option ''https://''.~~

	~~==== From the main repository ====~~
	~~The main repository is cloned like~~
	~~git clone https://gitlab.uib.no/pct/wpn.git~~

	~~The upstream link can be changed later to any other repository like e.g. a development fork as follows (given the clone directory is the current working directory)~~
	~~git remote set-url origin https://user@gitlab.uib.no/user/wpn.git~~

	~~The originally cloned remote repository will get the identifier ''origin'' in your local clone.~~

	~~==== From development fork ====~~
	~~Clone directly from your development fork~~
	~~git clone https://user@gitlab.uib.no/user/wpn.git~~

	~~This will create a local directory ''wpn'', an optional argument after the link allows to change the directory name, e.g.~~
	~~git clone https://user@gitlab.uib.no/user/wpn.git mywork~~

	~~==== Multiple upstream repositories ====~~
	As a more advanced option, multiple remote repositories can be added to the clone. All remote repositories are referenced through their identifiers, e.g. ''origin'' pointing to the fork and ''pctgroup'' pointing to main repository (chosen as an example).
	~~git remote add pctgroup https://gitlab.uib.no/pct/wpn.git~~

	~~==== Check configured upstream repositories ====~~
	~~The configured upstream repositories can be checked with~~
	~~git remote -v~~
	~~This will display the identifier and link to the configured upstream repositories.~~

	=== Pushing to development fork ===		=== Pushing to development fork ===

Mri083: /* Pull/Merge request */ moved to GitLab developer FAQ

2021-02-10T10:10:13Z

Pull/Merge request: moved to GitLab developer FAQ

@@ Line 94: / Line 94: @@
 Or using the direct link
      git push https://user@gitlab.uib.no/user/wpn.git dev
 === Importing an external package ===

← Older revision		Revision as of 13:58, 10 February 2021
Line 35:		Line 35:

	=== Get access to the repositories - without UiB account ===		=== Get access to the repositories - without UiB account ===
	It is possible to use a github user account to login to the UiB ~~gitlab~~, however such external users are not allowed to create forks in the ~~gitlab~~ domain.		It is possible to use a github user account to login to the UiB GitLab, however such external users are not allowed to create forks in the GitLab domain.
	Since forks are mandatory for the development cycle, github logins can effectively only be used for read access. Again the repository administrators		Since forks are mandatory for the development cycle, github logins can effectively only be used for read access. Again the repository administrators
	need to add you to the pCT group.		need to add you to the pCT group.
Line 41:		Line 41:
	Guest accounts for external developers can be set up, get in contact with the group over the general [[Documentation#Mailing lists and collaborative tools \| channels]]		Guest accounts for external developers can be set up, get in contact with the group over the general [[Documentation#Mailing lists and collaborative tools \| channels]]

	Further information:		Further information on the GitLab documentation webpages:
	* [https://docs.gitlab.com/ce/gitlab-basics/README.html Gitlab basics]		* [https://docs.gitlab.com/ce/gitlab-basics/README.html Gitlab basics]
	* [https://docs.gitlab.com/ee/workflow/README.html Gitlab workflow]		* [https://docs.gitlab.com/ee/workflow/README.html Gitlab workflow]

			<br>
			For further reading pick one of the topics below:
	==== [[GitLab best practice]] ====		==== [[GitLab best practice]] ====

	==== [[GitLab Developer FAQ]] ====		==== [[GitLab Developer FAQ]] ====

	==== [[Gitlab Master FAQ]] ====		==== [[Gitlab Master FAQ]] ====