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

Setup Hugo site with Docsy Theme #9

Merged
merged 1 commit into from
Aug 12, 2021

Conversation

nate-double-u
Copy link
Collaborator

@nate-double-u nate-double-u commented Aug 11, 2021

Closes #5, #10

First pass at notaryproject.dev - cloning etcd-io/website.
Deploy preview: https://deploy-preview-9--notarydev.netlify.app/

@netlify
Copy link

netlify bot commented Aug 11, 2021

✔️ Deploy Preview for notarydev ready!

🔨 Explore the source changes: 8b24c05

🔍 Inspect the deploy log: https://app.netlify.com/sites/notarydev/deploys/6115802ad953cb000784c850

😎 Browse the preview: https://deploy-preview-9--notarydev.netlify.app

@nate-double-u
Copy link
Collaborator Author

/cc @lachie83

@nate-double-u
Copy link
Collaborator Author

Link checker failed... I'll disable it for now.

Copy link
Collaborator

@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.

Hmm, maybe you didn't start from the latest version of etcd.io? For example, this PR contains check-hugo.sh.

Comment on lines +83 to +91
version_menu: Versions
versions:
latest: v2
all:
- v2
- v1
deprecation_warning: |-
the documentation is no longer actively maintained.
The page that you are viewing is the last archived version.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wish that we had cleaned this up first. Maybe we can do the cleanup in this repo and back port a solution.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I opened a PR a little bit ago that looks at doing some of that cleanup: etcd-io/website#354

Comment on lines 1 to 3
---
title: About
---
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are you sure that you want an about page? If not, drop this page.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think I'll keep it in for now, and have a discussion with the maintainers about it.

I've been looking at the issues/PRs list and can't find the discussion we had with the rationale behind cutting it. I remember agreeing, but it'd be good to link the issue. Do you recall where we had the conversation, @chalin?

For context, @SteveLasker, the whole site is basically about the project, so a specific about page can be a bit redundant (I know I've included an about in the docs assessment IA, but included it as a placeholder for discussion--I should be more clear about that in the assessment itself).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks!

Copy link
Collaborator

@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.

You'll need to get the latest etcd.io files. In particular, we don't want the version of render-link.html that is currently in this PR.

For details, see inlined comments.

@nate-double-u
Copy link
Collaborator Author

nate-double-u commented Aug 12, 2021

Hmm, maybe you didn't start from the latest version of etcd.io? For example, this PR contains check-hugo.sh.

I think you're right -- I'm disappointed that I missed this. I'd been working between two computers and think I did it on one but had to redo some work on the other. I'll apply your suggestions and try to do a diff and bring this repo up to speed.

Thanks for catching it!

@nate-double-u
Copy link
Collaborator Author

✔️ Deploy Preview for notarydev ready!

🔨 Explore the source changes: 57cc9b3

🔍 Inspect the deploy log: https://app.netlify.com/sites/notarydev/deploys/61141de6b40a130009ae6af9

😎 Browse the preview: https://deploy-preview-9--notarydev.netlify.app

This is new, I like that the Netlify bot now provides an info comment (with a deploy preview)

@nate-double-u nate-double-u requested a review from chalin August 12, 2021 18:14
@nate-double-u nate-double-u linked an issue Aug 12, 2021 that may be closed by this pull request
@nate-double-u
Copy link
Collaborator Author

Link checker failed... I'll disable it for now.

I've re-enabled it in the latest commit.

@nate-double-u
Copy link
Collaborator Author

@SteveLasker, in the footer I have the copyright line:

© 2013-2021 Notary Project Authors

I doubt this is the correct date range, do you know which year we should use as the start date here?

@nate-double-u nate-double-u force-pushed the hugo-docsy branch 2 times, most recently from 68237a7 to 9485309 Compare August 12, 2021 19:02
Copy link
Collaborator

@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.

I'd drop the About page now (it is harder to remove things once they're introduced). Other than that, and the minor inlined comments, LGTM.

@nate-double-u nate-double-u merged commit efba01f into notaryproject:main Aug 12, 2021
@nate-double-u nate-double-u deleted the hugo-docsy branch August 12, 2021 20:13
@nate-double-u
Copy link
Collaborator Author

Thanks for the feedback @chalin, I appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable link checker on preview Setup a Hugo website with a Docsy theme
2 participants