Skip to content

Commit e12e26a

Browse files
authored
Update documentation redirects to point to microshift-io repo (#220)
* Update Makefile targets and usage docs * Update npm packages * Update getting started and docs links
1 parent e07272f commit e12e26a

5 files changed

Lines changed: 1382 additions & 76 deletions

File tree

‎Makefile‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1-
2-
URL := http://localhost:1313
3-
OPEN_CMD := $(shell command -v open || command -v xdg-open || echo : 2>/dev/null)
41
HUGO_VERSION := 0.89.4/extended
5-
OUTPUT_DIR:=/
2+
HOSTNAME := $(shell hostname)
3+
PORT := 8080
4+
5+
.PHONY: server
6+
server: hugo
7+
./hugo server -w . \
8+
--bind 0.0.0.0 --port $(PORT) \
9+
-b http://$(HOSTNAME):$(PORT)
610

711
hugo:
812
@echo Downloading hugo wrapper
913
@curl -L -o hugo https://github.com/khos2ow/hugo-wrapper/releases/download/v1.6.0/hugow
10-
@@chmod +x hugo
14+
@chmod +x hugo
1115
@./hugo --get-version $(HUGO_VERSION)
1216

13-
server: hugo
14-
(sleep 2; $(OPEN_CMD) $(URL)) &
15-
./hugo server -w .
16-
17-
static: hugo
18-
./hugo -D
19-
20-
21-
.DEFAULT_GOAL := static
22-
23-
.PHONY: static server
17+
.PHONY: clean
18+
clean:
19+
rm -rf .hugo
20+
rm -f hugo .hugo_build.lock

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,11 @@ cd microshift-documentation
2323

2424
```bash
2525
npm install
26-
# if you do want to download and use hugo-extended in current directory
2726
make server
28-
# or if you already have hugo-extended installed in $PATH
29-
hugo serve
3027
```
3128

32-
This will start the local Hugo server on port 1313. Open up your browser to <http://localhost:1313> to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.
29+
This will start the local Hugo server on port 8080. Open up your browser to <http://localhost:8080> to view the website.
30+
As you make changes to the source files, Hugo updates the website and forces a browser refresh.
3331

3432
## Get involved with MicroShift
3533

‎content/en/_index.html‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@
2121

2222
We believe these properties should also make MicroShift a great tool for other use cases such as Kubernetes applications development on resource-constrained systems, scale testing, and provisioning of lightweight Kubernetes control planes.
2323

24-
### continue with:
25-
<button id="btn-concepts" class="button" onclick="location.href='https:\/\/github.com\/openshift\/microshift\/blob\/main\/docs\/user\/getting_started.md';"
26-
aria-label="Getting Started">Getting
27-
Started</button> <button id="btn-concepts" class="button" onclick="location.href='https:\/\/github.com\/openshift\/microshift#user-documentation';"
28-
aria-label="Microshift Documentation">Microshift
29-
Documentation</button>
24+
<button id="btn-concepts" class="button"
25+
onclick="location.href='https:\/\/github.com\/microshift-io\/microshift';"
26+
aria-label="Getting Started">
27+
Getting Started
28+
</button>
29+
<button id="btn-concepts" class="button"
30+
onclick="location.href='https:\/\/github.com\/microshift-io\/microshift\/blob\/main\/README.md';"
31+
aria-label="Documentation">
32+
Documentation
33+
</button>
3034

3135
{{% /blocks/feature-noimg %}}
3236
{{< /blocks/section >}}

‎layouts/partials/navbar.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
<ul class="navbar-nav mt-2 mt-lg-0">
77
{{ $p := . }}
88
<li class="nav-item mr-2 mb-lg-0">
9-
<a class="nav-link active" href="https://github.com/openshift/microshift/blob/main/docs/user/getting_started.md" >Getting Started</span></a>
9+
<a class="nav-link active" href="https://github.com/microshift-io/microshift" >Getting Started</span></a>
1010
</li>
1111
<li class="nav-item mr-2 mb-lg-0">
12-
<a class="nav-link active" href="https://github.com/openshift/microshift#user-documentation" >User Documentation</span></a>
12+
<a class="nav-link active" href="https://github.com/microshift-io/microshift/blob/main/README.md" >Documentation</span></a>
1313
</li>
1414
{{ if .Site.Params.versions }}
1515
<li class="nav-item dropdown">

0 commit comments

Comments
 (0)