Skip to content

Commit

Permalink
Update of Docsy and Hugo to latest versions. (#1073)
Browse files Browse the repository at this point in the history
* Update of Docsy to latest version.

Mainly done to get access to some new [shotcodes](https://www.docsy.dev/docs/adding-content/shortcodes/),
especially the `alert` and `swaggerui` shortcodes.

* Update of Hugo to latest version, and other adjustments

Lots of bug fixes that I had in the queue for both projects are now integrated,  so I removed workarounds.

Also new features in Huge/Docsy means we don't need the pager shortcode anymore, so that has been removed.
  • Loading branch information
markmandel authored and roberthbailey committed Sep 30, 2019
1 parent d6c6c65 commit 33a3df2
Show file tree
Hide file tree
Showing 10,379 changed files with 186,611 additions and 204,150 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion build/build-image/Dockerfile
Expand Up @@ -77,7 +77,7 @@ RUN curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.s
# \_/\_/ \___|_.__/|___/_|\__\___|
#

ENV HUGO_VER 0.55.2
ENV HUGO_VER 0.58.3
RUN mkdir /tmp/hugo && \
wget -q -O /tmp/hugo/hugo.tar.gz https://github.com/gohugoio/hugo/releases/download/v${HUGO_VER}/hugo_extended_${HUGO_VER}_Linux-64bit.tar.gz && \
tar -zxvf /tmp/hugo/hugo.tar.gz -C /tmp/hugo/ && \
Expand Down
2 changes: 0 additions & 2 deletions site/content/en/docs/Advanced/_index.md
Expand Up @@ -4,5 +4,3 @@ date: 2019-01-03T05:44:55Z
description: "Advanced Guides, Techniques and walk-throughs"
weight: 300
---

{{< pagelist >}}
2 changes: 0 additions & 2 deletions site/content/en/docs/Getting Started/_index.md
Expand Up @@ -7,5 +7,3 @@ date: 2017-01-05
description: >
Quickstarts for getting up and running with Agones
---

{{< pagelist >}}
2 changes: 0 additions & 2 deletions site/content/en/docs/Guides/_index.md
Expand Up @@ -7,5 +7,3 @@ date: 2019-01-02
description: >
Guides for deeper integrations with Agones
---

{{< pagelist >}}
2 changes: 0 additions & 2 deletions site/content/en/docs/Reference/_index.md
Expand Up @@ -6,5 +6,3 @@ description: >
Reference documentation for Agones Custom Resource Definitions
---

{{< pagelist >}}

2 changes: 0 additions & 2 deletions site/content/en/docs/Third Party Content/_index.md
Expand Up @@ -7,6 +7,4 @@ description: >
Content created by our community
---

{{< pagelist >}}


2 changes: 0 additions & 2 deletions site/content/en/docs/Tutorials/_index.md
Expand Up @@ -4,5 +4,3 @@ date: 2019-01-03T03:15:21Z
description: "Agones Tutorials"
weight: 10
---

{{< pagelist >}}
8 changes: 2 additions & 6 deletions site/content/en/docs/_index.md
Expand Up @@ -9,16 +9,12 @@ menu:
description: >
Documentation and usage guides on how to develop and host dedicated game servers on top of Agones.
---
Release version: {{< release-version >}}

These pages show you how to get up and running as quickly as possible in Agones.

If you are new to Agones, start with [Installation]({{< relref "./Installation/_index.md" >}}), to get Agones
up and running.

The [Getting Started]({{< relref "./Getting Started/_index.md" >}}) section will have you
first `GameServer` up and running, and then have you spinning up `Fleets` after that.

{{< pagelist >}}

<br/>
Release version: {{< release-version >}}
first `GameServer` up and running, and then have you spinning up `Fleets` after that.
7 changes: 0 additions & 7 deletions site/layouts/partials/pager.html

This file was deleted.

13 changes: 0 additions & 13 deletions site/layouts/shortcodes/pagelist.html

This file was deleted.

51 changes: 35 additions & 16 deletions site/themes/docsy/README.md
@@ -1,31 +1,50 @@
# Docsy

Docsy is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more.
Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more.

You can find an example site project that uses Docsy in [Docsy-Example](https://github.com/google/docsy-example). To use the Docsy Hugo theme, you can either:
This is not an officially supported Google product. This project is actively being maintained.

* Copy and edit the example site’s repo, which will also give you a skeleton structure for your top-level and documentation sections.
* Specify the Docsy theme like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/).
when creating or updating your site. This gives you all the theme-y goodness but you’ll need to specify your own site structure.
## Prerequisites

This is not an officially supported Google product. This project is currently maintained.
The following are basic prerequisites for using Docsy in your site:

## Installation and prerequisites
- Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the
[release page](https://github.com/gohugoio/hugo/releases), make sure you download the `_extended` version
which supports SCSS.

You need a recent version of Hugo to build sites using this theme (preferably 0.45+). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure to get the `extended` Hugo version which supports SCSS. Alternatively, on macOS you can install Hugo via Brew.
- Install `PostCSS` so that the site build can create the final CSS assets. You can install it locally by running
the following commands from the root directory of your project:

If you want to do stylesheet changes, you will also need `PostCSS` to create the final assets. You can also install it locally with:
```
sudo npm install -D --save autoprefixer
sudo npm install -D --save postcss-cli
```

```
npm install
````
## Example and usage

You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example). The Docsy Example Project is hosted at [https://example.docsy.dev/](https://example.docsy.dev/).

To use the Docsy theme for your own site:

- (Recommended) Copy the [example project](https://github.com/google/docsy-example),
 which includes the Docsy theme as a submodule.
You can customize this pre-configured basic site into your own Docsy themed site.
[Learn more...](https://github.com/google/docsy-example)

- Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or
clone the Docsy theme into your project.

To use a local version of the theme files, clone the repo using:
See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/) for
details about the various usage options.

## Documentation

Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsy.dev/](https://docsy.dev/). Alternatively you can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above:

```
git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
cd docsy/userguide/
hugo server --themesDir ../..
```

## Theme documentation

Detailed documentation for this theme is in the [Docsy example site](https://github.com/google/docsy-example) under **Documentation - Getting Started**.
Note that you need the `themesDir` flag when running Hugo because the site files are inside the theme repo.
Binary file added site/themes/docsy/assets/icons/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 33a3df2

Please sign in to comment.