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

Normalize product files format #2124

Closed
marcwrobel opened this issue Dec 20, 2022 · 7 comments · Fixed by #2125
Closed

Normalize product files format #2124

marcwrobel opened this issue Dec 20, 2022 · 7 comments · Fixed by #2125

Comments

@marcwrobel
Copy link
Member

Currently product files format is not consistent. There is no order and no formatting for attributes in the front matter, no fixed line length, no uniform markdown syntax (for example some page are using inline links, others are using links reference definitions - even when the link is not repeated).

This issue is about finding some basic and common rules in order to have a more consistent and readable format across all product markdown files.

@marcwrobel marcwrobel changed the title Normalize product file format Normalize product files format Dec 20, 2022
@marcwrobel
Copy link
Member Author

marcwrobel commented Dec 20, 2022

A few rules used in #2125 :

  • Order of attributes (each block is separated by a blank line):
    1. Product level informations
    2. title / category / iconSlug / permalink / alternate_urls / versionCommand / releasePolicyLink
    3. changelogTemplate / releaseLabel / LTSLabel
    4. activeSupportColumn / releaseColumn / releaseDateColumn / eolColumn
    5. purls
    6. auto
    7. releases (each release is separated by a blank line)
  • Max line length in description: 100 characters (exceptions are OK for instance for lines ending with a long link).
  • No links reference definitions, except if link is repeated.
  • No use of <abbr> (prefer the following syntax *[<acronym>]: <title>).
  • Explain acronyms if it is not obvious or part of the product name (but try to avoid acronyms).
  • changelogTemplate on one line, between double quotes if it is containing a liquid expression (that may prevent the link to be split on multiple lines by latest.py - to be confirmed).

And some existing rules:

  • No quotes around dates.
  • Versions and cycles always inside double quotes.

@captn3m0
Copy link
Member

Created https://github.com/endoflife-date/endoflife.date/wiki/Style-Guide with rules from your comment above. Will expand over time.

@marcwrobel marcwrobel linked a pull request Dec 23, 2022 that will close this issue
marcwrobel added a commit that referenced this issue Dec 26, 2022
marcwrobel added a commit that referenced this issue Dec 26, 2022
marcwrobel added a commit that referenced this issue Dec 27, 2022
marcwrobel added a commit that referenced this issue Dec 28, 2022
marcwrobel added a commit that referenced this issue Dec 29, 2022
marcwrobel added a commit that referenced this issue Dec 29, 2022
marcwrobel added a commit that referenced this issue Dec 29, 2022
marcwrobel added a commit that referenced this issue Dec 29, 2022
marcwrobel added a commit that referenced this issue Dec 29, 2022
marcwrobel added a commit that referenced this issue Oct 26, 2023
marcwrobel added a commit that referenced this issue Oct 26, 2023
marcwrobel added a commit that referenced this issue Oct 26, 2023
marcwrobel added a commit that referenced this issue Oct 26, 2023
marcwrobel added a commit that referenced this issue Oct 26, 2023
marcwrobel added a commit that referenced this issue Oct 26, 2023
@marcwrobel
Copy link
Member Author

Now it's finished !

usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
usta pushed a commit that referenced this issue Oct 27, 2023
marcwrobel added a commit that referenced this issue Oct 28, 2023
marcwrobel added a commit that referenced this issue Oct 28, 2023
marcwrobel added a commit that referenced this issue Oct 28, 2023
marcwrobel added a commit that referenced this issue Oct 28, 2023
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 a pull request may close this issue.

3 participants