tektoncd / website

Tekton Website

https://tekton.dev

Apache License 2.0

62 stars 149 forks source link

Update docsy version #421

Closed geriom closed 1 year ago

geriom commented 1 year ago

Changes

Changes Preview

Docsy now has versioned releases and uses Hugo modules (a wraper around Go modules). This PR update the website to be compatible with the latest version of Docsy.

Create go.mod and go.sum files for compatibility with Hugo modules.
Delete checked-in theme and dependencies.
Update base layout for compatibility with latest theme.
Update packaje.json to match required dependencies and replace legacy values
Cosmetic changes: Collapsed nav bar with animation to expand/collapse, change code highlighting theme to "manni" which matches the overall colors scheme better.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you review them:

[x] Includes docs (if user facing)
[x] Commit messages follow commit message best practices

See the contribution guide for more details.

afrittoli commented 1 year ago

/cc @AlanGreene @dibyom @abayer

tekton-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/tektoncd/website/blob/main/OWNERS)~~ [afrittoli] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

AlanGreene commented 1 year ago

The only other thing I've found so far is that the links in the right sidebar are broken or incomplete. I'll continue reviewing this evening.

e.g.

On the live site these work as expected https://tekton.dev/docs/pipelines/container-contract/

They link to:

On the new preview https://deploy-preview-421--tekton.netlify.app/docs/pipelines/container-contract/

the view / edit links point to the website repo instead of pipeline repo
the create issue links don't include the page title

AlanGreene commented 1 year ago

Just noticed the header changes to blue when scrolling down the home page:

geriom commented 1 year ago

The only other thing I've found so far is that the links in the right sidebar are broken or incomplete. I'll continue reviewing this evening.

Fixed. I copied the old page-metadata-links partial into Tekton to overwrite the default behavior and keep the current style.

Just noticed the header changes to blue when scrolling down the home page.

Fixed. Added style that sets the background to 'dark' when scrolling.

@AlanGreene PTAL

AlanGreene commented 1 year ago

Looks great, thanks @geriom /lgtm