-
Notifications
You must be signed in to change notification settings - Fork 517
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
Add Community to website navbar, add events to community as subfolder #1281
Conversation
✅ Deploy Preview for tag-security ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
b5a6fb5
to
0a4d5c0
Compare
I have been trying to fix the linter links check but it looks like a couple of sched links keep returning 429 (too many requests), and I suspect its due to the large amount of links being tested in this PR. I can open the links fine from my laptop. Is there a workaround for that? EDIT: fixed the issue by increasing retry times and number of retries on the links checker CI job |
a1d84f1
to
6a20778
Compare
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 for grabbing this off of the #1257 TODO list! Each iteration helps with finding a state of flow.
Community as a navbar item feels appropriate in my opinion. The placement of events among a list of initiatives feels like something we can refine. (maybe we can nest the initiatives under a sub-directory?).
Thoughts on a structure such as:
.
|-- community
| |-- events
| | |-- README.md
| |-- working-groups
| | |-- README.md
| | |-- controls
| | | |-- README.md
| |-- research
| | |-- README.md
CC: @eddie-knight @anvega
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.
This highlights an issue regarding sorting past events and future events.
Having this file within events is a dramatic improvement from having it at the repo top level, but does it now require website visitors to click and read the entry to determine whether it is a past or upcoming event? If so, do we have any way to improve that?
Happy to file this as a nit to address in a followup PR, if we have some type of consensus the matter.
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.
What if we can set this up to behave like the Blog page? Might be as simple as overriding this layout file with a copy of the blog template. Might also take more work, but WDYT— worth a try?
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.
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.
Blog posts get grouped by year based on their heading, e.g.:
---
title: "Clusters for all cloud tenants"
date: 2022-06-02 13:04:00 +0200
author: Josh Gavant
---
I think the best approach would be to create standalone files for each event (both past and future, e.g. each CNSCon event gets its own page) and creating a heading for each of them so that they are automatically grouped based on the year. This would improve readability and fix the sorting issue you mentioned above, but it requires a bit more work as individual files are created for each event.
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.
That matches the approach I used for the image above. If we add the headers to the event files, they will behave like blog posts within this subsection. Then we'd be able to remove the past and future events files.
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.
@brandtkeller @mrcdb Do yall want me to push the commit to this PR or in a follow-up?
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.
I can help with updating the event files and checking in the blog-alike layout for community events myself, but please feel free to push any commit to this PR if you have already built some of that 👍
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.
@eddie-knight I have pushed an initial commit that would add the events on a timeline similarly to what is done for blogs. the only problem I couldn't fix is how to apply the custom layout to community/events
, not sure if this is a Hugo limitation (I am not really an expert on that).
As a workaround, I had to move Events as a top-level menu item so that the custom layout would only apply to the events and not affect the other pages in community
, which otherwise wouldn't display correctly.
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.
The last commit seems to be a large divergence from your previous approach 🤔 If you'd like to roll it back, I can make a small commit that allows for a similar result while keeping the Events content in the Community directory.
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.
Yep, I did try to make it work (see my comment above) but faced some limitations. I have reverted my previous commit, please feel free to push your commit 👍
I like the idea. Stirs up more ideas about community structure... but I'll save those for later. |
@brandtkeller I thought the same when testing out the changes. Having the events page at the same level as each working group sounds a bit inconsistent, I'd second your idea of having a "working groups" folder that includes all the WGs collaterals as sub-folders. Happy to give a try at this in this PR. |
What if we modify the directories to have WG at the end of each? We could open this up for discussion as a followup item. |
Appending |
5471f3f
to
d6fffe2
Compare
- renames files to follow same naming convention (hyphens) Signed-off-by: Marco De Benedictis <[email protected]>
Signed-off-by: Marco De Benedictis <[email protected]>
Signed-off-by: Marco De Benedictis <[email protected]>
Signed-off-by: Marco De Benedictis <[email protected]>
Signed-off-by: Marco De Benedictis <[email protected]>
Signed-off-by: Marco De Benedictis <[email protected]>
d6fffe2
to
2280124
Compare
Dottore @mrcdb! Nice one. To respond to @brandtkeller, I don't have strong thoughts on a final structure. It's all fluid, and we can continue to iterate until we arrive at what it should be for now, although the thinking is synchronized with #1283. As part of the lift there, I created an If you have a look at this document, you can get a view of the current target structure of the repo org. I deliberately didn't contemplate website impact there, so I'll defer on that to you all. It hadn't really been part of the workflow on maintaining the repo until your work that is underway here. As part of that first #1283, I also moved the workgroup subdirectories under a I didn't create markdown READMEs for |
From a sequencing standpoint, we should probably review #1273 given its size, as merging this one first will result in conflicts that won't be easily resolved. |
@mrcdb I left a comment above— I don't think this PR is in a good state right now, but if we roll it back I'm happy to add a follow-up PR or commit with the changes needed to get the bloggy behavior in |
2280124
to
98feb2d
Compare
Agree on that, I just rolled this back to the previous state. Happy for you to add a commit in the repo to get the desired behaviour for |
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.
LGTM! Thanks Marco.
This PR addresses open issues mentioned in #1257 regarding the Events content that is currently conveyed on the TAG security website.
In particular, the PR:
community
folder as a navbar item in the website in place of the existing events page, which is currently managed fromwebsite/content
community/events
subfolder in the repositorycommunity/events subfolder
(also updating naming convention so they all show with hyphens on the website)community/
andcommunity/events
for improved website navigation experience