Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade Hugo + Docsy to latest versions #1819

Closed
markmandel opened this issue Sep 15, 2020 · 6 comments · Fixed by #2123
Closed

Upgrade Hugo + Docsy to latest versions #1819

markmandel opened this issue Sep 15, 2020 · 6 comments · Fixed by #2123
Assignees
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. area/site The website itself - including redirects, styling, search, etc kind/cleanup Refactoring code, fixing up documentation, etc
Milestone

Comments

@markmandel
Copy link
Member

Once Hugo and/or Docsy can handle [email protected], let's upgrade both Docsy and Hugo to the latest versions.

Also just nice to be on the latest.

Context:
Originally posted by @markmandel in #1818 (comment)

@markmandel markmandel added area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. area/site The website itself - including redirects, styling, search, etc kind/cleanup Refactoring code, fixing up documentation, etc labels Sep 15, 2020
@markmandel
Copy link
Member Author

Code synatx highlighting might be a nice new feature:
https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-prism

@markmandel
Copy link
Member Author

https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid
https://mermaid-js.github.io/mermaid/#/

This could replace some of our dot and plantuml image generation, making the site simpler to update.

@roberthbailey
Copy link
Member

Mark updated Hugo already: #2085

I'm going to look at upgrading docsy.

@roberthbailey roberthbailey self-assigned this May 11, 2021
@roberthbailey
Copy link
Member

Since I couldn't find any instructions on how to update docsy for the agones website, I'm going to add some notes about what I do here.

Looking at https://www.docsy.dev/docs/updating/#update-your-docsy-clone there are two ways to update docsy depending on how it's installed. @markmandel said that in our case we do "a straight clone locally and vendor operation" and that "we may also have some local hacks in there (I think most I changed I submitted back to upstream, but good to keep an eye out just in case)"

@roberthbailey
Copy link
Member

First try:

$ git remote add docsy https://github.com/google/docsy.git
$ cd site/themes
$ git pull docsy master
remote: Enumerating objects: 5410, done.
remote: Counting objects: 100% (484/484), done.
remote: Compressing objects: 100% (231/231), done.
remote: Total 5410 (delta 299), reused 364 (delta 223), pack-reused 4926
Receiving objects: 100% (5410/5410), 7.86 MiB | 10.59 MiB/s, done.
Resolving deltas: 100% (3123/3123), done.
From https://github.com/google/docsy
 * branch              master     -> FETCH_HEAD
 * [new branch]        master     -> docsy/master
hint: Pulling without specifying how to reconcile divergent branches is
hint: discouraged. You can squelch this message by running one of the following
hint: commands sometime before your next pull:
hint: 
hint:   git config pull.rebase false  # merge (the default strategy)
hint:   git config pull.rebase true   # rebase
hint:   git config pull.ff only       # fast-forward only
hint: 
hint: You can replace "git config" with "git config --global" to set a default
hint: preference for all repositories. You can also pass --rebase, --no-rebase,
hint: or --ff-only on the command line to override the configured default per
hint: invocation.
fatal: refusing to merge unrelated histories

Next try:

$ mv docsy docsy.orig
$ git clone https://github.com/google/docsy

Now I can diff the two directories and decide what to keep.

@markmandel
Copy link
Member Author

Not quite sure if I was clear when we chatted -- but I would clone Docsy to a completely different directory, not try and do it in the Agones working folder.

Sounds like you ended up in the same place 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. area/site The website itself - including redirects, styling, search, etc kind/cleanup Refactoring code, fixing up documentation, etc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants