Skip to content

Commit

Permalink
Documentation updates for project transition. (#740)
Browse files Browse the repository at this point in the history
Documentation updates for project transition.

This updates documentation for the project transition to ENA as well
as changing the deployment method of the documentation website.
  • Loading branch information
aaronhurt authored Jan 22, 2020
1 parent 9c6c64a commit 619abba
Show file tree
Hide file tree
Showing 10 changed files with 110 additions and 27 deletions.
28 changes: 28 additions & 0 deletions Dockerfile-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
FROM alpine:latest
MAINTAINER Aaron Hurt <[email protected]>

ARG hugo_version=0.62.2
EXPOSE 1313

## install hugo and other needed packages
RUN apk update && \
apk add --no-cache ca-certificates && \
wget -q -O - \
https://github.com/gohugoio/hugo/releases/download/v${hugo_version}/hugo_${hugo_version}_Linux-64bit.tar.gz \
| tar -zxf - hugo && \
mv hugo /usr/local/bin/hugo && \
chmod 0755 /usr/local/bin/hugo

## populate hugo source
COPY docs /srv

## setup hugo resource cache
RUN mkdir -p /srv/resources && \
chown nobody:nobody /srv/resources

## do not run as root
USER nobody

## launch hugo and serve docs
ENTRYPOINT ["/usr/local/bin/hugo"]
CMD ["serve", "--disableFastRender", "--bind", "0.0.0.0", "--source", "/srv"]
61 changes: 61 additions & 0 deletions docs.nomad
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
job "fabiolb-docs" {
datacenters = [
"nsvltn",
"iplsin"
]
type = "service"
update {
max_parallel = 1
auto_revert = true
}
group "deploy" {
count = 4
constraint {
attribute = "${node.datacenter}"
operator = "distinct_property"
value = "2"
}
restart {
attempts = 3
interval = "30m"
delay = "15s"
mode = "fail"
}
ephemeral_disk {
size = 750
}
task "docker" {
driver = "docker"
config {
image = "fabiolb/fabio-docs"
}
service {
name = "fabiolb-docs"
tags = [
"urlprefix-fabiolb.net/",
]
address_mode = "driver"
port = 1313
check {
address_mode = "driver"
port = 1313
type = "http"
path = "/check/ok"
interval = "20s"
timeout = "5s"
}
}
env {
SERVICE_IGNORE = "true"
}
resources {
cpu = 500
memory = 1024
}
logs {
max_files = 5
max_file_size = 100
}
}
}
}
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

This is the source code for the https://fabiolb.net website.

It is built with [Hugo](https://gohugo.io/) and deployed automatically
to [Netlify](https://netlify.com/).
It is built with [Hugo](https://gohugo.io/) and automatically deployed
via [Bamboo](https://www.atlassian.com/software/bamboo) and
[Nomad](https://www.nomadproject.io/) to [ENA](https://github.com/myENA)'s Docker infrastructure
and exposed through [Consul](https://consul.io/) and [Fabio](https://fabiolb.net/).

The theme is [TheDocs](http://thetheme.io/thedocs/) from [TheTheme.io](http://thetheme.io/).

Expand Down
1 change: 1 addition & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
baseURL = "https://fabiolb.net/"
languageCode = "en-us"
title = "fabio - The Consul Load-Balancer"
disableKinds = ["taxonomy", "taxonomyTerm"]

[params]
googleAnalytics = "UA-2812942-5"
6 changes: 4 additions & 2 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ announces the paths the upstream service accepts, e.g. `urlprefix-/user` or

### Maintainer

Fabio was developed and is maintained by Frank Schröder and the great community.
Fabio was developed and maintained by Frank Schröder through January, 2020. Since that date primary maintenance
has been the responsibility of [ENA](https://github.com/myENA) and the great community of users.

It was originally developed at the [eBay Classifieds Group](https://www.ebayclassifiedsgroup.com/) in Amsterdam, The Netherlands.
It was originally developed at the [eBay Classifieds Group](https://www.ebayclassifiedsgroup.com/)
in Amsterdam, The Netherlands.
10 changes: 3 additions & 7 deletions docs/content/code-of-conduct/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: "Code of Conduct"
weight: 1000
---

<div class="jumbotron">
<div class="container">
<h1>Be nice and treat others with respect &#128524;</h1>
<p>I am happy to mediate if there is a dispute.</p>
<p><a class="btn btn-primary btn-lg" href="mailto:[email protected]?subject=Dispute" role="button">Mail me</a></p>
</div>
</div>
Be nice and treat others with respect.

Please contact a project owner if you need mediation with a dispute.
9 changes: 2 additions & 7 deletions docs/content/contact/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,5 @@ title: "Contact"
weight: 2000
---

To get in touch with me
ping me on <a href="https://twitter.com/magiconair"><i class="fa fa-twitter" aria-hidden="true"></i> Twitter</a>
or open an issue on <a href="https://github.com/fabiolb/fabio/issues"><i class="fa fa-github" aria-hidden="true"></i> GitHub</a>.

Have fun

Frank Schröder
Please create a [GitHub]("https://github.com/fabiolb/fabio/issues") issue for all feature requests, bugs and general
questions about the project. You may also contact any project owner for other concerns.
9 changes: 3 additions & 6 deletions docs/layouts/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<div class="row">
<div class="col-md-6 col-sm-6">
<p style="line-height: 26px;">
Copyright &copy; {{ now.Format "2006"}} Frank Schröder. All right reserved.
</br>
Last updated on {{ now.Format "2 Jan 2006 15:04"}}
Copyright &copy; 2006 - 2020 Frank Schröder. All right reserved.</br>
Copyright &copy; 2020 - {{ now.Format "2020" }} Education Networks of America. All right reserved.</br>
Last updated on {{ now.Format "2 Jan 2006 15:04"}}
</p>
</div>
<div class="col-md-6 col-sm-6">
Expand All @@ -18,9 +18,6 @@
<li>
<a href="https://gohugo.io"><img src="/img/made-with-hugo.png" height="51px"></a>
</li>
<li>
<a href="https://www.netlify.com"><img src="https://www.netlify.com/img/global/badges/netlify-dark.svg"></a>
</li>
</ul>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/layouts/partials/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
{{range .Site.Sections}}
{{$section := .}}
<li>
<a class="{{if eq $currentPage.URL .URL}} active{{end}}" href="{{.URL}}">{{.Title}}</a>
{{if and .Pages (hasPrefix $currentPage.URL $section.URL)}}
<a class="{{if eq $currentPage.Permalink .Permalink}} active{{end}}" href="{{.Permalink}}">{{.Title}}</a>
{{if and .Pages (hasPrefix $currentPage.Permalink $section.Permalink)}}
<ul class="open">
{{range .Pages}}
<li><a{{if eq $currentPage.URL .URL}} class="active"{{end}} href="{{.URL}}">{{.Title}}</a></li>
<li><a{{if eq $currentPage.Permalink .Permalink}} class="active"{{end}} href="{{.Permalink}}">{{.Title}}</a></li>
{{end}}
</ul>
{{end}}
Expand Down
1 change: 1 addition & 0 deletions docs/static/check/ok
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ok

0 comments on commit 619abba

Please sign in to comment.