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

Standardize blog post tags and ensure posts are appropriately tagged #1232

Closed
smlambert opened this issue Nov 26, 2022 · 8 comments · Fixed by #1951
Closed

Standardize blog post tags and ensure posts are appropriately tagged #1232

smlambert opened this issue Nov 26, 2022 · 8 comments · Fixed by #1951
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@smlambert
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The blog is now moved to this repo. Its a good time to review the existing blog posts and make sure they carry useful, commonly named tags that can be leveraged elsewhere.

Describe the solution you'd like
For example, if I want to mention all of the posts that have been written on the topic of secure development and look at
https://adoptium.net/blog/tags/Security/ - I would like to see this post tagged in the same way and in the 'Security' list: https://adoptium.net/blog/2022/06/adoptium-reproducible-builds/

We can establish and standardize a set of tags we for sure want to use (existing ones include temurin and security), and also suggest others (like releases, aqavit and jlink). Having a standard set will help reduce duplication, currently some posts use an 'Eclipse Temurin' while others use 'Temurin'

Additional context
Once we have a set of common tags, it can/should be part of a blog post review to check we are using them to best advantage.

@smlambert smlambert added the enhancement New feature or request label Nov 26, 2022
@gdams
Copy link
Member

gdams commented Nov 28, 2022

Perhaps we should have a defined set of tags in a JSON file that we validate tags against (e.g force users to see the existing list of tags before creating new ones). We could also parse the markdown config file in a GitHub action and run basic sanity checks against tags (e.g no capitals, no spaces etc)

@smlambert
Copy link
Contributor Author

FYI @jiekang (relating to using a standardized tag for release announcement posts)

@gdams gdams added the good first issue Good for newcomers label May 16, 2023
@gdams
Copy link
Member

gdams commented Jul 4, 2023

here's the list of unique tags:

  "distinct": [
    "AQAvit",
    "AQAvit quality",
    "Adoptium",
    "Announcement",
    "Docker",
    "EMT4J",
    "Eclipse Foundation",
    "Eclipse Temurin",
    "EclipseCon",
    "Infrastructure",
    "JVM",
    "Java",
    "Nagios",
    "OpenJDK",
    "Release",
    "Security",
    "Temurin",
    "Working Group"
  ]

@hendrikebbers
Copy link
Contributor

My ideas:

  • Do we want Eclipse Temurin or Temurin as a tag? (same for all other subprojects) - I would vote for Temurin
  • Adoptium and Working Group should be merged
  • AQAvit quality should be removed
  • JVM, OpenJDK and Java should be merged to Java and OpenJDK
  • Nagios should be removed

@smlambert
Copy link
Contributor Author

smlambert commented Jul 4, 2023

My preferred convention for tags is to try to use single-word tags where possible, and if multi-word, separate them with a hyphen. Also prefer that we have a convention of all lowercase for all tags (including any new ones that get added to the set).

temurin
aqavit
emt4j
adoptium
java
openjdk
infrastructure
security
announcement
release-notes
infrastructure

and use tags that people would recognize if we presented a 'tag cloud' on the side of the blog page.

@gdams
Copy link
Member

gdams commented Jul 5, 2023

My preferred convention for tags is to try to use single-word tags where possible, and if multi-word, separate them with a hyphen. Also prefer that we have a convention of all lowercase for all tags (including any new ones that get added to the set).

temurin aqavit emt4j adoptium java openjdk infrastructure security announcement release-notes infrastructure

and use tags that people would recognize if we presented a 'tag cloud' on the side of the blog page.

yeah lowercase does make sense to me here, I'm also wondering about enhancing the tag page to be able to filter by several tags as right now it's a bit static, I'll have a little think about how that could work.

@Ndacyayisenga-droid
Copy link
Contributor

Ndacyayisenga-droid commented Jul 5, 2023

My preferred convention for tags is to try to use single-word tags where possible, and if multi-word, separate them with a hyphen. Also prefer that we have a convention of all lowercase for all tags (including any new ones that get added to the set).
temurin aqavit emt4j adoptium java openjdk infrastructure security announcement release-notes infrastructure
and use tags that people would recognize if we presented a 'tag cloud' on the side of the blog page.

yeah lowercase does make sense to me here, I'm also wondering about enhancing the tag page to be able to filter by several tags as right now it's a bit static, I'll have a little think about how that could work.

Can this be any easy to validate this when a PR is triggered?. That may be CI will break if a wrong tag convention is assigned to a blog post🤔. How easy can we force someone writing a blog post to use the right tag convention🤔?

@gdams
Copy link
Member

gdams commented Jul 5, 2023

we already have a blog validator workflow which we could extend to sanitise tags https://github.com/adoptium/adoptium.net/blob/main/.github/workflows/blog-validator.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
4 participants