Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
6
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Switch to GitLab Next
Sign in / Register
Toggle navigation
K
korovax-employee-wiki
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Iterations
Merge Requests
0
Merge Requests
0
Requirements
Requirements
List
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Test Cases
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Package Registry
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issue
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
KoroVax
korovax-employee-wiki
Commits
1173a1ae
Commit
1173a1ae
authored
Oct 25, 2020
by
Josh Hong
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
poc done with readme
parent
5c7650ed
Pipeline
#207258385
passed with stages
in 1 minute and 11 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
106 additions
and
95 deletions
+106
-95
README.md
README.md
+7
-95
ikiwiki-README.md
ikiwiki-README.md
+99
-0
No files found.
README.md
View file @
1173a1ae

# README
---
Extracted wiki template from GitLab pages examples.
Example [ikiwiki] website using GitLab Pages
.
This POC will be complementary to the whole suite of offerings which KoroVax will use internally
.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
Todo:
-
The employee wiki will list what each employee is responsible for, eg, Josh will be in charge of the krs-admin-portal
-
Please note that not all repository should be made public, relevant ones with business data should be made private
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
*generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
[
GitLab CI
](
#gitlab-ci
)
-
[
Building locally
](
#building-locally
)
-
[
GitLab User or Group Pages
](
#gitlab-user-or-group-pages
)
-
[
Did you fork this project?
](
#did-you-fork-this-project
)
-
[
Troubleshooting
](
#troubleshooting
)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## GitLab CI
This project's static Pages are built by
[
GitLab CI
][
ci
]
, following the steps
defined in
[
`.gitlab-ci.yml`
](
.gitlab-ci.yml
)
:
```
yaml
image
:
elecnix/ikiwiki
before_script
:
-
apt-get install -y git
-
git submodule init
-
git submodule update
test
:
stage
:
test
script
:
-
ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
only
:
-
branches
-
tags
pages
:
stage
:
deploy
script
:
-
ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
artifacts
:
paths
:
-
public
only
:
-
master
```
We are using a theme based on Bootstrap 4 using submodules, and in order to
enable the theme plugin, we must pass the
`libdir`
parameter.
## Building locally
To work locally with this project, you'll have to follow the steps below:
1.
Fork, clone or download this project
1.
[
Install
][]
ikiwiki
1.
Clone the submodules:
`git submodule init && git submodule update`
1.
Generate the website:
`ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib`
1.
Preview your project: open
`public/index.html`
in a browser
Read more at ikiwiki's
[
documentation
][]
.
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to
`namespace.gitlab.io`
, where
`namespace`
is
your
`username`
or
`groupname`
. This can be done by navigating to your
project's
**Settings**
.
Read more about
[
user/group Pages
][
userpages
]
and
[
project Pages
][
projpages
]
.
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings**
and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Troubleshooting
1.
CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or
your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
[
ci
]:
https://about.gitlab.com/gitlab-ci/
[
ikiwiki
]:
https://ikiwiki.info/
[
install
]:
https://ikiwiki.info/install/
[
documentation
]:
https://ikiwiki.info/
[
userpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[
projpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
POC Site: https://korovax.gitlab.io/korovax-employee-wiki
\ No newline at end of file
ikiwiki-README.md
0 → 100644
View file @
1173a1ae

---
Example [ikiwiki] website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
*generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
[
GitLab CI
](
#gitlab-ci
)
-
[
Building locally
](
#building-locally
)
-
[
GitLab User or Group Pages
](
#gitlab-user-or-group-pages
)
-
[
Did you fork this project?
](
#did-you-fork-this-project
)
-
[
Troubleshooting
](
#troubleshooting
)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## GitLab CI
This project's static Pages are built by
[
GitLab CI
][
ci
]
, following the steps
defined in
[
`.gitlab-ci.yml`
](
.gitlab-ci.yml
)
:
```
yaml
image
:
elecnix/ikiwiki
before_script
:
-
apt-get install -y git
-
git submodule init
-
git submodule update
test
:
stage
:
test
script
:
-
ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
only
:
-
branches
-
tags
pages
:
stage
:
deploy
script
:
-
ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
artifacts
:
paths
:
-
public
only
:
-
master
```
We are using a theme based on Bootstrap 4 using submodules, and in order to
enable the theme plugin, we must pass the
`libdir`
parameter.
## Building locally
To work locally with this project, you'll have to follow the steps below:
1.
Fork, clone or download this project
1.
[
Install
][]
ikiwiki
1.
Clone the submodules:
`git submodule init && git submodule update`
1.
Generate the website:
`ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib`
1.
Preview your project: open
`public/index.html`
in a browser
Read more at ikiwiki's
[
documentation
][]
.
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to
`namespace.gitlab.io`
, where
`namespace`
is
your
`username`
or
`groupname`
. This can be done by navigating to your
project's
**Settings**
.
Read more about
[
user/group Pages
][
userpages
]
and
[
project Pages
][
projpages
]
.
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings**
and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Troubleshooting
1.
CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or
your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
[
ci
]:
https://about.gitlab.com/gitlab-ci/
[
ikiwiki
]:
https://ikiwiki.info/
[
install
]:
https://ikiwiki.info/install/
[
documentation
]:
https://ikiwiki.info/
[
userpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[
projpages
]:
https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment