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

Streamline and update README.md #1273

Merged
merged 9 commits into from
Jun 20, 2024
Merged

Streamline and update README.md #1273

merged 9 commits into from
Jun 20, 2024

Conversation

anvega
Copy link
Contributor

@anvega anvega commented Jun 11, 2024

As discussed during the last leads meeting, this PR updates the readme to make it more streamlined and less bloated. Changes include:

  • Combined the Objective, Background, and Mission sections under a single "About Us" header for a more cohesive introduction.
  • Simplified language and content throughout the document for clarity and ease of understanding.
  • Added a table format for publications to improve readability and accessibility, sorted by date in ascending order.
  • Updated meeting information to be less words but keep direct links to CNCF and TAG Security calendars.

These updates aim to provide a more concise and friendly experience for visitors and contributors.

Streamline and update TAG Security README

- Combined Objective, Background, and Mission sections under "About Us" header.
- Simplified and consolidated content for clarity and brevity.
- Updated publication links and added a table format for better readability, sorted by date in ascending order.
- Revised meeting information to be less words.

Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
Copy link

netlify bot commented Jun 11, 2024

Deploy Preview for tag-security ready!

Name Link
🔨 Latest commit c420884
🔍 Latest deploy log https://app.netlify.com/sites/tag-security/deploys/66739449fb247d00089c56cd
😎 Deploy Preview https://deploy-preview-1273--tag-security.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.

anvega added 4 commits June 11, 2024 11:59
Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
anvega and others added 2 commits June 11, 2024 13:26
Removed issue to organize gatherings
Reworded key focus areas

Signed-off-by: Andrés Vega <av@messier42.com>

Signed-off-by: Andrés Vega <av@messier42.com>
Copy link
Collaborator

@JustinCappos JustinCappos left a comment

Choose a reason for hiding this comment

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

PR looks good overall. The assessments are fairly numerous, so it may or may not be wise to move them to a different section or de-emphasize them somehow. I'm fine with how it is now though and will defer to others.

@eddie-knight
Copy link
Collaborator

I agree with @JustinCappos that a list of publications (especially assessments) is cumbersome on the front page.

@anvega
Copy link
Contributor Author

anvega commented Jun 12, 2024

One of the key principles of intentional Information Architecture is prioritizing the visitor's experience. We need to consider what visitors are looking for and how they can easily find that information, whether through search or navigation.

If someone has heard about an assessment and comes here to find it, having it readily available on the front page allows them to locate it quickly without needing to click through multiple pages or dig for it. More cumbersome is coming to find something quickly and struggling to locate it when it's buried three levels deep.

For visitors who are unaware of the assessments, having a selection of key ones listed on the front page serves as an introduction, showing that these resources exist. Perhaps a good approach is to specify that the listed assessments are selected samples, and provide a note that the complete list can be found in the directory.

Removes assessments from list

Signed-off-by: Andrés Vega <av@messier42.com>
Signed-off-by: Andrés Vega <av@monkey.org>

Signed-off-by: Andrés Vega <av@messier42.com>
@anvega
Copy link
Contributor Author

anvega commented Jun 20, 2024

I unlisted the assessments from the publication list based on feedback.

@anvega anvega merged commit 65bb763 into main Jun 20, 2024
3 checks passed
@anvega anvega deleted the anvega-streamline-readme branch June 20, 2024 02:30
@eddie-knight
Copy link
Collaborator

Thank you @anvega!

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.

3 participants