From 08971fc9a5365edfbc58c4bca426ea43fad536b6 Mon Sep 17 00:00:00 2001 From: Cassandra Gould van Praag <casssandra.gouldvanpraag@psych.ox.ac.uk> Date: Tue, 7 Sep 2021 21:18:15 +0100 Subject: [PATCH] moved gitlab to seperate top level --- docs/{tools => }/gitlab.md | 39 +------------- .../gitlab/1-1-tools-command-line.md | 4 +- docs/{tools => }/gitlab/1-2-tools-markdown.md | 4 +- docs/{tools => }/gitlab/1-3-tools-atom.md | 4 +- .../gitlab/2-1-starting-gitlab-account.md | 4 +- .../gitlab/2-2-starting-configure-git.md | 4 +- .../gitlab/2-3-starting-local-repo.md | 4 +- .../gitlab/2-4-starting-git-basics.md | 4 +- ...-collaborating-stranger-or-collaborator.md | 4 +- .../3-2-collaborating-fork-their-repo.md | 4 +- .../3-3-collaborating-play-with-this-page.md | 4 +- .../gitlab/4-1-you-make-your-repo.md | 4 +- docs/{tools => }/gitlab/4-2-you-doi.md | 4 +- .../gitlab/4-3-you-make-your-pages-site.md | 4 +- .../gitlab/5-1-projectmanagement-issues.md | 4 +- .../5-2-projectmanagement-milestones.md | 4 +- docs/gitlab/gitlab-tutorials.md | 51 +++++++++++++++++++ 17 files changed, 82 insertions(+), 68 deletions(-) rename docs/{tools => }/gitlab.md (57%) rename docs/{tools => }/gitlab/1-1-tools-command-line.md (98%) rename docs/{tools => }/gitlab/1-2-tools-markdown.md (96%) rename docs/{tools => }/gitlab/1-3-tools-atom.md (97%) rename docs/{tools => }/gitlab/2-1-starting-gitlab-account.md (96%) rename docs/{tools => }/gitlab/2-2-starting-configure-git.md (95%) rename docs/{tools => }/gitlab/2-3-starting-local-repo.md (98%) rename docs/{tools => }/gitlab/2-4-starting-git-basics.md (98%) rename docs/{tools => }/gitlab/3-1-collaborating-stranger-or-collaborator.md (96%) rename docs/{tools => }/gitlab/3-2-collaborating-fork-their-repo.md (98%) rename docs/{tools => }/gitlab/3-3-collaborating-play-with-this-page.md (98%) rename docs/{tools => }/gitlab/4-1-you-make-your-repo.md (98%) rename docs/{tools => }/gitlab/4-2-you-doi.md (98%) rename docs/{tools => }/gitlab/4-3-you-make-your-pages-site.md (99%) rename docs/{tools => }/gitlab/5-1-projectmanagement-issues.md (82%) rename docs/{tools => }/gitlab/5-2-projectmanagement-milestones.md (82%) create mode 100644 docs/gitlab/gitlab-tutorials.md diff --git a/docs/tools/gitlab.md b/docs/gitlab.md similarity index 57% rename from docs/tools/gitlab.md rename to docs/gitlab.md index 7e1cf27f..e84d21fa 100644 --- a/docs/tools/gitlab.md +++ b/docs/gitlab.md @@ -1,9 +1,8 @@ --- layout: default title: Git and GitLab -parent: Open WIN Tools has_children: true -nav_order: 5 +nav_order: 7 --- @@ -38,39 +37,3 @@ Git and GitLab are an excellent resource for inviting others to contribute to yo #### GitLab pages GitLab pages allows you to build professional looking websites, like this one! It is relatively straightforward to build a simple website to share your work with the world, and the options for building in additional complexity are endless. - - -## How to use -Follow the below tutorials (left in the navigation panel) to set up and use GitLab for hosting, communicating and managing your version controlled projects - -### 1. Tools for git and GitLab -- [1.1 Using the command line](1-1-tools-command-line) -- [1.2 Writing in markdown](1-2-tools-markdown) -- [1.3 Atom text editor](1-3-tools-atom) - -### 2. Getting started -- [2.1 Your GitLab account](2-1-starting-gitlab-account) -- [2.2 Global git configuration](2-2-starting-configure-git) -- [2.3 Your local repository](2-3-starting-local-repo) -- [2.4 Basic git commands](2-4-starting-git-basics) - -### 3. Collaborating on GitLab -- [3.1 Collaborating on GitLab](3-1-collaborating-stranger-or-collaborator) -- [3.2 Collaborating with a stranger](3-2-collaborating-fork-their-repo) -- [3.3 Play with this page](3-3-collaborating-play-with-this-page) - -### 4. Making and publishing your repository -- [4.1 Make a repository](4-1-you-make-your-repo) -- [4.2 Create a doi](4-2-you-doi) -- [4.3 Making your pages site](4-3-you-make-your-pages-site) - -### 5. Managing your project on GitLab -- [5.1 GitLab issues](5-1-projectmanagement-issues) -- [5.2 GitLab milestones](5-2-projectmanagement-milestones) - -## Who should I ask for further advice about using GitLab -The Open WIN community are a great resource for support in using GitLab. [Join the community](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/) and try asking your question on slack! - -You are very welcome to as the [Open WIN Engagement Coordinator](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/community/community-who/#community-coordinator---cassandra-gould-van-praag-sheher) for specific advice on using GitLab. - -Technical issues on the GitLab instance should be directed to [WIN IT](https://sharepoint.nexus.ox.ac.uk/sites/NDCN/FMRIB/IT/Pages/default.aspx). diff --git a/docs/tools/gitlab/1-1-tools-command-line.md b/docs/gitlab/1-1-tools-command-line.md similarity index 98% rename from docs/tools/gitlab/1-1-tools-command-line.md rename to docs/gitlab/1-1-tools-command-line.md index 5b324d99..abbdfa72 100644 --- a/docs/tools/gitlab/1-1-tools-command-line.md +++ b/docs/gitlab/1-1-tools-command-line.md @@ -1,8 +1,8 @@ --- layout: default title: 1.1 Using the command line -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 1 --- diff --git a/docs/tools/gitlab/1-2-tools-markdown.md b/docs/gitlab/1-2-tools-markdown.md similarity index 96% rename from docs/tools/gitlab/1-2-tools-markdown.md rename to docs/gitlab/1-2-tools-markdown.md index d660e310..f71f97c4 100644 --- a/docs/tools/gitlab/1-2-tools-markdown.md +++ b/docs/gitlab/1-2-tools-markdown.md @@ -1,8 +1,8 @@ --- layout: default title: 1.2 Writing in markdown -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 2 --- diff --git a/docs/tools/gitlab/1-3-tools-atom.md b/docs/gitlab/1-3-tools-atom.md similarity index 97% rename from docs/tools/gitlab/1-3-tools-atom.md rename to docs/gitlab/1-3-tools-atom.md index 34701e3f..8a4c0bd3 100644 --- a/docs/tools/gitlab/1-3-tools-atom.md +++ b/docs/gitlab/1-3-tools-atom.md @@ -1,8 +1,8 @@ --- layout: default title: 1.3 Atom text editor -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 3 --- diff --git a/docs/tools/gitlab/2-1-starting-gitlab-account.md b/docs/gitlab/2-1-starting-gitlab-account.md similarity index 96% rename from docs/tools/gitlab/2-1-starting-gitlab-account.md rename to docs/gitlab/2-1-starting-gitlab-account.md index 1a3cadff..e302218c 100644 --- a/docs/tools/gitlab/2-1-starting-gitlab-account.md +++ b/docs/gitlab/2-1-starting-gitlab-account.md @@ -1,8 +1,8 @@ --- layout: default title: 2.1 Your GitLab account -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 4 --- diff --git a/docs/tools/gitlab/2-2-starting-configure-git.md b/docs/gitlab/2-2-starting-configure-git.md similarity index 95% rename from docs/tools/gitlab/2-2-starting-configure-git.md rename to docs/gitlab/2-2-starting-configure-git.md index 15111941..cffe101d 100644 --- a/docs/tools/gitlab/2-2-starting-configure-git.md +++ b/docs/gitlab/2-2-starting-configure-git.md @@ -1,8 +1,8 @@ --- layout: default title: 2.2 Global git configuration -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 5 --- diff --git a/docs/tools/gitlab/2-3-starting-local-repo.md b/docs/gitlab/2-3-starting-local-repo.md similarity index 98% rename from docs/tools/gitlab/2-3-starting-local-repo.md rename to docs/gitlab/2-3-starting-local-repo.md index 5fb49edf..cd937ed9 100644 --- a/docs/tools/gitlab/2-3-starting-local-repo.md +++ b/docs/gitlab/2-3-starting-local-repo.md @@ -1,8 +1,8 @@ --- layout: default title: 2.3 Your local repository -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 6 --- diff --git a/docs/tools/gitlab/2-4-starting-git-basics.md b/docs/gitlab/2-4-starting-git-basics.md similarity index 98% rename from docs/tools/gitlab/2-4-starting-git-basics.md rename to docs/gitlab/2-4-starting-git-basics.md index 91211410..02602998 100644 --- a/docs/tools/gitlab/2-4-starting-git-basics.md +++ b/docs/gitlab/2-4-starting-git-basics.md @@ -1,8 +1,8 @@ --- layout: default title: 2.4 Basic git commands -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 7 --- diff --git a/docs/tools/gitlab/3-1-collaborating-stranger-or-collaborator.md b/docs/gitlab/3-1-collaborating-stranger-or-collaborator.md similarity index 96% rename from docs/tools/gitlab/3-1-collaborating-stranger-or-collaborator.md rename to docs/gitlab/3-1-collaborating-stranger-or-collaborator.md index b946c141..9c14ee5a 100644 --- a/docs/tools/gitlab/3-1-collaborating-stranger-or-collaborator.md +++ b/docs/gitlab/3-1-collaborating-stranger-or-collaborator.md @@ -1,8 +1,8 @@ --- layout: default title: 3.1 Collaborating on GitLab -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 8 --- diff --git a/docs/tools/gitlab/3-2-collaborating-fork-their-repo.md b/docs/gitlab/3-2-collaborating-fork-their-repo.md similarity index 98% rename from docs/tools/gitlab/3-2-collaborating-fork-their-repo.md rename to docs/gitlab/3-2-collaborating-fork-their-repo.md index b6d699da..4f3a1ae9 100644 --- a/docs/tools/gitlab/3-2-collaborating-fork-their-repo.md +++ b/docs/gitlab/3-2-collaborating-fork-their-repo.md @@ -1,8 +1,8 @@ --- layout: default title: 3.2 Collaborating with a stranger -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 9 --- diff --git a/docs/tools/gitlab/3-3-collaborating-play-with-this-page.md b/docs/gitlab/3-3-collaborating-play-with-this-page.md similarity index 98% rename from docs/tools/gitlab/3-3-collaborating-play-with-this-page.md rename to docs/gitlab/3-3-collaborating-play-with-this-page.md index 6be72c60..14febb11 100644 --- a/docs/tools/gitlab/3-3-collaborating-play-with-this-page.md +++ b/docs/gitlab/3-3-collaborating-play-with-this-page.md @@ -1,8 +1,8 @@ --- layout: default title: 3.3 Play with this page -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 10 --- diff --git a/docs/tools/gitlab/4-1-you-make-your-repo.md b/docs/gitlab/4-1-you-make-your-repo.md similarity index 98% rename from docs/tools/gitlab/4-1-you-make-your-repo.md rename to docs/gitlab/4-1-you-make-your-repo.md index ecf9197f..88da8632 100644 --- a/docs/tools/gitlab/4-1-you-make-your-repo.md +++ b/docs/gitlab/4-1-you-make-your-repo.md @@ -1,8 +1,8 @@ --- layout: default title: 4.1 Make a repository -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 11 --- diff --git a/docs/tools/gitlab/4-2-you-doi.md b/docs/gitlab/4-2-you-doi.md similarity index 98% rename from docs/tools/gitlab/4-2-you-doi.md rename to docs/gitlab/4-2-you-doi.md index c05f7d44..d2fbfd48 100644 --- a/docs/tools/gitlab/4-2-you-doi.md +++ b/docs/gitlab/4-2-you-doi.md @@ -1,8 +1,8 @@ --- layout: default title: 4.2 Create a doi -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 12 --- diff --git a/docs/tools/gitlab/4-3-you-make-your-pages-site.md b/docs/gitlab/4-3-you-make-your-pages-site.md similarity index 99% rename from docs/tools/gitlab/4-3-you-make-your-pages-site.md rename to docs/gitlab/4-3-you-make-your-pages-site.md index 1e39c415..69c0fa25 100644 --- a/docs/tools/gitlab/4-3-you-make-your-pages-site.md +++ b/docs/gitlab/4-3-you-make-your-pages-site.md @@ -1,8 +1,8 @@ --- layout: default title: 4.3 Making your pages site -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 13 --- diff --git a/docs/tools/gitlab/5-1-projectmanagement-issues.md b/docs/gitlab/5-1-projectmanagement-issues.md similarity index 82% rename from docs/tools/gitlab/5-1-projectmanagement-issues.md rename to docs/gitlab/5-1-projectmanagement-issues.md index 09f42c91..4cf2eb91 100644 --- a/docs/tools/gitlab/5-1-projectmanagement-issues.md +++ b/docs/gitlab/5-1-projectmanagement-issues.md @@ -1,8 +1,8 @@ --- layout: default title: 5.1 GitLab issues -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 14 --- diff --git a/docs/tools/gitlab/5-2-projectmanagement-milestones.md b/docs/gitlab/5-2-projectmanagement-milestones.md similarity index 82% rename from docs/tools/gitlab/5-2-projectmanagement-milestones.md rename to docs/gitlab/5-2-projectmanagement-milestones.md index cec42c34..bf012552 100644 --- a/docs/tools/gitlab/5-2-projectmanagement-milestones.md +++ b/docs/gitlab/5-2-projectmanagement-milestones.md @@ -1,8 +1,8 @@ --- layout: default title: 5.2 GitLab milestones -parent: Git and GitLab -grand_parent: Open WIN Tools +parent: Tutorials +grand_parent: Git and GitLab has_children: false nav_order: 15 --- diff --git a/docs/gitlab/gitlab-tutorials.md b/docs/gitlab/gitlab-tutorials.md new file mode 100644 index 00000000..22932d91 --- /dev/null +++ b/docs/gitlab/gitlab-tutorials.md @@ -0,0 +1,51 @@ +--- +layout: default +title: Tutorials +parent: Git and GitLab +has_children: false +nav_order: 1 +--- + + +# Get to grips with GitLab +{: .fs-8 } + +Follow this series of tutorials to start working with GitLab +{: .fs-6 .fw-300 } + +--- + +## How to use +Follow the below tutorials (left in the navigation panel) to set up and use GitLab for hosting, communicating, collaborating on and managing your version controlled projects. + +### 1. Tools for git and GitLab +- [1.1 Using the command line](1-1-tools-command-line) +- [1.2 Writing in markdown](1-2-tools-markdown) +- [1.3 Atom text editor](1-3-tools-atom) + +### 2. Getting started +- [2.1 Your GitLab account](2-1-starting-gitlab-account) +- [2.2 Global git configuration](2-2-starting-configure-git) +- [2.3 Your local repository](2-3-starting-local-repo) +- [2.4 Basic git commands](2-4-starting-git-basics) + +### 3. Collaborating on GitLab +- [3.1 Collaborating on GitLab](3-1-collaborating-stranger-or-collaborator) +- [3.2 Collaborating with a stranger](3-2-collaborating-fork-their-repo) +- [3.3 Play with this page](3-3-collaborating-play-with-this-page) + +### 4. Making and publishing your repository +- [4.1 Make a repository](4-1-you-make-your-repo) +- [4.2 Create a doi](4-2-you-doi) +- [4.3 Making your pages site](4-3-you-make-your-pages-site) + +### 5. Managing your project on GitLab +- [5.1 GitLab issues](5-1-projectmanagement-issues) +- [5.2 GitLab milestones](5-2-projectmanagement-milestones) + +## Who should I ask for further advice about using GitLab +The Open WIN community are a great resource for support in using GitLab. [Join the community](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/contact/) and try asking your question on slack! + +You are very welcome to ask the [Open WIN Engagement Coordinator](https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/community/community-who/#community-coordinator---cassandra-gould-van-praag-sheher) for specific advice on using GitLab. + +Technical issues on the GitLab instance should be directed to [WIN IT](https://sharepoint.nexus.ox.ac.uk/sites/NDCN/FMRIB/IT/Pages/default.aspx). -- GitLab