GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Create the Python Docs Editorial Board static site using Hugo by Mariatta · Pull Request #13 · python/editorial-board

Conversation

@Mariatta

@Mariatta Mariatta commented Aug 21, 2024

Copy link
Copy Markdown
Member

Features:

  • search box
  • Archives
  • RSS feed at /index.xml

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@netlify

netlify Bot commented Aug 21, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

✅ Deploy Preview for pythoneditorialboard ready!

Name Link
🔨 Latest commit b4cd784
🔍 Latest deploy log https://app.netlify.com/sites/pythoneditorialboard/deploys/66c9002835d6ed0008a8ecc2
😎 Deploy Preview https://deploy-preview-13--pythoneditorialboard.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nedbat

nedbat commented Aug 21, 2024

Copy link
Copy Markdown
Member

This is great! The theme is a bit subtle. In light mode, I can't tell what words are links. Dark mode has a bit more contrast, but still seems to be hiding the links a bit. Are there other easy options?

Mariatta reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Mariatta

Mariatta commented Aug 21, 2024

Copy link
Copy Markdown
Member Author

Hmm I can try adjusting the CSS. Do you want colors to be different, or would adding underlines work?

Usually I don't like customizing theme because I don't want to maintain it, and also I only have newbie-level CSS knowledge. But if others can help adjust and maintain the CSS then I'm ok with customization.

I tried looking at some other minimalistic and lightweight Hugo themes, but many are outdated/maintained, like their demo site doesn't even work. This theme still seemed to be well maintained.

Another theme I can try to work with is: https://docs.vantage-design.com/ace/ . Would this be of interest?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@AA-Turner

AA-Turner commented Aug 21, 2024

Copy link
Copy Markdown
Member

Out of curiosity, would a Sphinx project be considered here? Though less 'landing page' like, it does have advantages in that it allows cross-linking to other Python docs sites and vice versa.

I'm a little biased perhaps, but themes like Furo have well tested designs that we use for example in the docs-community site, whereas I don't see Hugo used as often.

A

ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Mariatta

Mariatta commented Aug 21, 2024

Copy link
Copy Markdown
Member Author

To me, Sphinx is too heavy-weight for this purpose. I like using Sphinx for documentation because of the cross-linking feature and auto API documentation, but even I, as an experienced Python user, struggled with it when trying to use it for things like personal blog/website. I found having to spend more time configuring and setting it up, disabling certain features, adjusting template, instead of writing content. Maybe some themes have made it easier, but it still a developer-focused framework.

Whereas Hugo is built for website/landing page/blogging, which is the main purpose for this site. I don't know any Golang, but I could set it up and start writing content quickly, so I chose to optimize for this.

The main consumable content on this site is the markdown files under contents directory, which can already be accessed via GitHub repository. The static site is just a front to serve the markdown in different formats. If we realize that we need features from Sphinx later on, it should not be difficult to convert into Sphinx, and this can definitely be re-evaluated later on.

We haven't use Hugo static site before within the CPython core team, so perhaps you can consider this as a small trial for a small site that has a small audience to begin with.

I hope we don't need to keep arguing about which tools we use here, because in my mind, both tools are good, both have its own pro and cons, both produces a static site. I think the output static site is more important than the tool being used to build it.

AA-Turner reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Aug 21, 2024

Copy link
Copy Markdown
Member

Do you want colors to be different, or would adding underlines work?

Underlines in main body text are a big plus for accessibility. WCAG guidelines say colour alone shouldn't be used for these prose links.

This doesn't necessarily apply to th ig lime navigation, header and footer links, like the grid of links to the minutes from the homepage.

For more info, see references in python/python-docs-theme#160 and python/python-docs-theme#169.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@gvanrossum

gvanrossum commented Aug 21, 2024

Copy link
Copy Markdown
Member

Big yes for underlines from a geezer with declining eyesight.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Mariatta

Mariatta commented Aug 21, 2024

Copy link
Copy Markdown
Member Author

I added a custom css to underline links, please check the output: https://deploy-preview-13--pythoneditorialboard.netlify.app/

I also updated the readme with instructions on how to write up new content/updates.

Sample screenshots:

Landing Page

Screenshot 2024-08-21 at 2 35 45 PM

/updates/ page

Screenshot 2024-08-21 at 2 35 51 PM

/archives/ page

Screenshot 2024-08-21 at 2 35 59 PM

/search/ page

Screenshot 2024-08-21 at 2 36 15 PM

hugovk reacted with hooray emoji
All reactions
  • 🎉 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nedbat

nedbat commented Aug 21, 2024

Copy link
Copy Markdown
Member

Looks great, thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@AA-Turner

AA-Turner commented Aug 21, 2024

Copy link
Copy Markdown
Member

I hope we don't need to keep arguing about which tools we use here, because in my mind, both tools are good, both have its own pro and cons, both produces a static site. I think the output static site is more important than the tool being used to build it.

No argument intended, and as you note form follows function. If nothing else, I consider this useful feedback!

A

Mariatta reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk
hugovk approved these changes Aug 22, 2024
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Underlines look good, thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread README.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread README.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread README.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread README.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@willingc
willingc self-requested a review August 22, 2024 23:22
willingc
willingc approved these changes Aug 22, 2024
View reviewed changes

@willingc willingc left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks @Mariatta. Let's give this a try. We can always adapt to another framework if the need arises. Results on lighthouse look good (SEO could be inched up in the future). 💐

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@willingc

willingc commented Aug 22, 2024

Copy link
Copy Markdown
Contributor

@Mariatta 🚢

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Mariatta added 6 commits August 23, 2024 14:31
@Mariatta
Create Editorial Board static site using Hugo
6b24e3d
@Mariatta
Update readme with instructions on how to build the static site
cc15aee
@Mariatta
Change the base url
297a167
@Mariatta
Add netlify.toml
d3b266c
@Mariatta
Make links underlined.
028290a
Add some templates.
Fix typo in update entry.
Update readme with info on how to write new content.
@Mariatta
Update date formatting in updates archetype
b4cd784
@Mariatta
Mariatta force-pushed the add-static-site branch from a7d95a0 to b4cd784 Compare August 23, 2024 21:33
@Mariatta
Mariatta merged commit 9b8ea26 into main Aug 23, 2024
@Mariatta
Mariatta deleted the add-static-site branch August 23, 2024 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@willingc willingc willingc approved these changes
+1 more reviewer
@hugovk hugovk hugovk approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@Mariatta @nedbat @AA-Turner @hugovk @gvanrossum @willingc
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.