Skip to content

etcd.io docsy conversion#112

Merged
nate-double-u merged 11 commits intoetcd-io:docsyfrom
nate-double-u:docsy-conversion
Mar 24, 2021
Merged

etcd.io docsy conversion#112
nate-double-u merged 11 commits intoetcd-io:docsyfrom
nate-double-u:docsy-conversion

Conversation

@nate-double-u
Copy link
Copy Markdown
Contributor

@nate-double-u nate-double-u commented Mar 12, 2021 •
edited
Loading

A work in progress attempt to convert etcd.io to use a Docsy theme.

Game plan:

  • Generate site using the Docsy Example site
  • Pull in Documentation as is
    • Move Documentation to content/en folder
    • Ensure no links/bookmarks are broken in the conversion process
  • Ensure front page content created is the same as the original page
  • Ensure site builds
    • locally (make serve, using hugo serve)
    • locally (make docker-serve)
    • netlify
  • update README
  • Look & Feel updates
    • Front page and documentation sections should look similar to the original site (not like the default Docsy)
  • Ensure that existing functionality is not lost
    • Versions
  • Bring in language safe version selector from PoC Ensure that only the docs for actively selected version show up in the side-nav #135

Contributes to:

  • Convert to Docsy #134
  • Etcd.io Docs/SEO Improvement Plan #65

/cc @jberkus @spzala @zacharysarah @chalin

Deploy previews:

@nate-double-u nate-double-u changed the title Etcd docsy conversion etcd.io docsy conversion Mar 12, 2021
@nate-double-u nate-double-u force-pushed the docsy-conversion branch 18 times, most recently from ef24b6c to 187c1d6 Compare March 13, 2021 01:38
@nate-double-u

This comment has been minimized.

Sign in to view
@nate-double-u nate-double-u force-pushed the docsy-conversion branch 4 times, most recently from 3041076 to 9d7a567 Compare March 14, 2021 22:17
@nate-double-u

This comment has been minimized.

Sign in to view
@nate-double-u

This comment has been minimized.

Sign in to view
@nate-double-u nate-double-u mentioned this pull request Mar 15, 2021
Closed
22 tasks
@chalin
Copy link
Copy Markdown
Contributor

chalin commented Mar 15, 2021

I was able to get a build going on my own netlify instance to at least get a deploy preview:

Great progress!

But the main etcd-io netlify deploy system is still stuck.

The error I'm seeing in the build log is because the version of Hugo used to build the site is too old. Oh, I just noticed that you did update the version of Hugo used by the Docker build, but that there's still an error. I'll have another look as soon as I can.

@nate-double-u
Copy link
Copy Markdown
Contributor Author

nate-double-u commented Mar 15, 2021

I was able to get a build going on my own netlify instance to at least get a deploy preview:

Great progress!

Thanks!

But the main etcd-io netlify deploy system is still stuck.

The error I'm seeing in the build log is because the version of Hugo used to build the site is too old. Oh, I just noticed that you did update the version of Hugo used by the Docker build, but that there's still an error. I'll have another look as soon as I can.

I can bring both the Dockerfile and the netlify.toml file up to version 81.0 as per #113 and see if that helps.

chalin
chalin reviewed Mar 23, 2021
View reviewed changes
chalin
chalin reviewed Mar 23, 2021
View reviewed changes
@nate-double-u
Copy link
Copy Markdown
Contributor Author

nate-double-u commented Mar 23, 2021 •
edited
Loading

@nate-double-u: Is assets/icons/logo.svg a new file (it is shown as new, but was it copied from elsewhere)?

I think I brought it in from https://github.com/cncf/artwork (https://github.com/cncf/artwork/tree/master/projects/etcd/icon/color) thinking it would be better for the logo to be served from the site. I think it was originally being served from raw.githubusercontent.com.

How would we attribute (CC-by-4.0) an asset like that? Do we need to in this case? (I'm presuming we should, though I think it was originally linked to it directly)

chalin
chalin reviewed Mar 23, 2021
View reviewed changes
yarn.lock
@@ -1,18 +0,0 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
Copy link
Copy Markdown
Contributor

@chalin chalin Mar 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll be rebasing often, and I've found it a pain to rebase .lock files.

Actually, IMHO it isn't worth the headache of committing a .lock file for websites. In the case of etcd.io we only have a small set of dev dependencies. My suggestion would be to drop the .lock file from master, and propagate that change to here.

Copy link
Copy Markdown
Contributor Author

@nate-double-u nate-double-u Mar 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've found the same -- I'll remove the lock files before merging.

@nate-double-u nate-double-u mentioned this pull request Mar 23, 2021
Closed
@nate-double-u
updating package.json & removing package-lock.json
5e6958d 
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
chalin
chalin reviewed Mar 23, 2021
View reviewed changes
chalin
chalin approved these changes Mar 23, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start for the docsy branch. The only issue to be addressed (either before or after this is merged), is https://github.com/etcd-io/website/pull/112/files#r600039579

@nate-double-u
updating config.toml
f0158d8 
reinstating redirects config settings

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
updating Makefile
5b066b6 
changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u nate-double-u merged commit 183d5f9 into etcd-io:docsy Mar 24, 2021
@nate-double-u nate-double-u deleted the docsy-conversion branch March 24, 2021 00:19
@nate-double-u nate-double-u mentioned this pull request Mar 24, 2021
Closed
34 tasks
@nate-double-u
Copy link
Copy Markdown
Contributor Author

nate-double-u commented Mar 24, 2021 •
edited
Loading

Issue #134 's main description comment has been updated with the struck parts of this PRs description.

nate-double-u added a commit that referenced this pull request Mar 24, 2021
@nate-double-u
etcd.io docsy conversion (#112)
16b8265 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Mar 24, 2021
@nate-double-u
etcd.io docsy conversion (#112)
bbc8bf1 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Mar 25, 2021
@nate-double-u
etcd.io docsy conversion (#112)
217f12c 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Mar 26, 2021
@nate-double-u
etcd.io docsy conversion (#112)
0eb0746 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 6, 2021
@nate-double-u
etcd.io docsy conversion (#112)
6076b24 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 7, 2021
@nate-double-u
etcd.io docsy conversion (#112)
473e9c5 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 9, 2021
@nate-double-u
etcd.io docsy conversion (#112)
414e02d 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 12, 2021
@nate-double-u
etcd.io docsy conversion (#112)
337c247 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 12, 2021
@nate-double-u
etcd.io docsy conversion (#112)
0d10a05 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 13, 2021
@nate-double-u
etcd.io docsy conversion (#112)
a0fd1d5 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit that referenced this pull request Apr 15, 2021
@nate-double-u
etcd.io docsy conversion (#112)
29d2952 
First pass at integrating etcd into a shell docsy themed hugo site.

* Moving content/docs to content/en/docs
* Updating netlify.toml, config.toml, and Docker config
* first pass at versions dropdown menu for docs pages
* Updating hugo version to 0.81.0 (ext) in Dockerfile and netlify.toml
* updating preview-build command
* updating package.json
* requiring lts node version
* Adding content to en/_index.html, updating config.toml, updating navbar-version-selector to ensure it works with multiple languages.
* updating package.json & removing package-lock.json
* changing from npm ci to npm install as we removed the package-lock.json file

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u pushed a commit that referenced this pull request Apr 26, 2021
@chalin
Docsy theme (#244)
86b070b 
* etcd.io docsy conversion, first pass at integrating etcd into a shell docsy themed hugo site (#112)

* New footer, and version-selector; fixes empty-hrefs (#207)

* Homepage tweaks (#209)

* Adjust titles, weights and landing pages for docs (#213)

* Homepage rework (#219)

* Link to etcd resources in footer (#229)

* Drop About from docsy MVP, and make link checker happy (#227)

* Etcd has graduated! (#230)

* Format next's landing page like all other doc vers landing pages (#231)

* Add etcd favicon (#232)

* [docsy] Show next version name as v3.5-DRAFT (#233)

* Add page warning for all doc version pages other than latest (#237)

* Organize blog entries by year (#239)

* Site 404 page (#240)

* Reinstate metrics (#242)

* Remove obsolete comment (#243)

Co-authored-by: Patrice Chalin <pchalin@gmail.com>
Co-authored-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
NotAwar pushed a commit to NotAwar/website that referenced this pull request Feb 27, 2025
@chalin
Docsy theme (etcd-io#244)
d08fb09 
* etcd.io docsy conversion, first pass at integrating etcd into a shell docsy themed hugo site (etcd-io#112)

* New footer, and version-selector; fixes empty-hrefs (etcd-io#207)

* Homepage tweaks (etcd-io#209)

* Adjust titles, weights and landing pages for docs (etcd-io#213)

* Homepage rework (etcd-io#219)

* Link to etcd resources in footer (etcd-io#229)

* Drop About from docsy MVP, and make link checker happy (etcd-io#227)

* Etcd has graduated! (etcd-io#230)

* Format next's landing page like all other doc vers landing pages (etcd-io#231)

* Add etcd favicon (etcd-io#232)

* [docsy] Show next version name as v3.5-DRAFT (etcd-io#233)

* Add page warning for all doc version pages other than latest (etcd-io#237)

* Organize blog entries by year (etcd-io#239)

* Site 404 page (etcd-io#240)

* Reinstate metrics (etcd-io#242)

* Remove obsolete comment (etcd-io#243)

Co-authored-by: Patrice Chalin <pchalin@gmail.com>
Co-authored-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chalin chalin chalin approved these changes

Assignees

No one assigned

Labels

docsy Categorizes issue or PR as related to the docsy conversion project.

Projects

None yet

Milestone

21Q2-site-reorg

Development

Successfully merging this pull request may close these issues.

2 participants

@nate-double-u @chalin