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

docs(contributing): Homogenize format across translated files #6625

Merged

Conversation

davorpa
Copy link
Member

@davorpa davorpa commented Nov 20, 2021

What does this PR do?

Improve repo

  • Remove trailing spaces
  • Apply headings 2-1 empty lines fpb-lint rule
  • Anchor aliases <a name="" ... to inside list items. Fixes: MD032/blanks-around-lists
  • 4-spaces indentation according to .editorconfig param
  • Homogenize format & indent of code blocks. Fixes: MD040/fenced-code-language, MD046/code-block-style
  • Use "consistent" unordered list mark: -. Fixes: MD004/ul-style
  • No spaces in formats and link text. Fixes: MD037/no-space-in-emphasis, MD038/no-space-in-code, MD039/no-space-in-links
  • Git, GitHub, YouTube, Leanpub trademarks Typos
  • From inside to outside. Ending puntuations in parenthesis-brackets.
  • Pull Request (PR) & ISBN acronym
  • Highlight filenames
  • Highlight markups and literal texts.
  • Typos and link for archived annotations proposal: "archived" resources #6301
  • Fix broken link in ES translation: 40ca417
  • Revert ElivreFoundation & free-programming-livres literals in FR translation: e66d3a6
  • Complete docs file moving made in move the translated documentation files to a docs folder #6614: 65d2408 + 9e31d14

GHP preview URL: https://davorpa.github.io/free-programming-books/

Checklist:

Follow-up

  • Check the status of GitHub Actions and resolve any reported warnings!

... there where an anchor alias `<a name="...">` is used near to each of those list items

This solves markdownlint `MD032/blanks-around-lists` issue
- Format using fenced style.
- Well indent in those placed inside list enumerations.
- Simulate `Good` - `Bad` monospace double colon indent inside each one.

- Examples highlighting as `text-plain`. The `md, markdown` style doesn't work very well since blocks has mixed syntax.
- `check_urls` code block highlighted as `properties` style (key-value pair).

Solves markdownlint rules:
- MD040/fenced-code-language: Fenced code blocks should have a language specified
- MD046/code-block-style: Code block style [Expected: indented; Actual: fenced]
- Simulate `Good` - `Bad` monospace double colon indent inside each one.

Revert commit f9dc719 only in this file after check non-needs in a deployed web snapshot
Solves markdownlint rules:
MD004/ul-style: Unordered list style "consistent"
markdownlint rules:
MD037/no-space-in-emphasis: Spaces inside emphasis
MD038/no-space-in-code: Spaces inside code span elements
MD039/no-space-in-links: Spaces inside link text
It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself
- `et al.`
- File extensions `.md`
- Protocols: `http`, `https`...
- Notes: LeanPub, require email, StackOverflow, in process, archived

trailing dots in that lines
@davorpa davorpa added the waiting for changes PR has been reviewed and changes/suggestions requested label Jan 29, 2022
@eshellman
Copy link
Collaborator

one conflict left

@davorpa davorpa added conflicts Conflict(s) need to be resolved and removed waiting for changes PR has been reviewed and changes/suggestions requested labels Jan 31, 2022
@davorpa davorpa marked this pull request as draft January 31, 2022 18:55
…g/sync/1

fix(docs): Use Kramdown processor (EbookFoundation#6677)
* Update _config.yml
* add markdown="1"
* update url
* complete removing spaces?
* explicitly use kramdown

(cherry picked from commit de2f319)
@davorpa davorpa removed the conflicts Conflict(s) need to be resolved label Feb 2, 2022
@davorpa davorpa marked this pull request as ready for review February 2, 2022 21:34
@davorpa davorpa requested review from eshellman and removed request for eshellman February 2, 2022 21:34
@davorpa
Copy link
Member Author

davorpa commented Feb 2, 2022

#6677 merged, so conflict solved 😜

@eshellman eshellman merged commit 84438cb into EbookFoundation:main Feb 3, 2022
@EbookFoundation EbookFoundation locked as resolved and limited conversation to collaborators Feb 3, 2022
@davorpa davorpa linked an issue Feb 16, 2022 that may be closed by this pull request
9 tasks
@davorpa davorpa added 🗣️ locale:de Resources addressing "German / Deutsch" language 🗣️ locale:el Resources addressing "Greek / Hellenic / ελληνικά" language 🗣️ locale:en Resources addressing "English" language 🗣️ locale:es Resources addressing "Spanish / español" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:vi Resources addressing "Vietnamese / Tiếng Việt" language 🗣️ locale:zh Resources addressing "Chinese" language labels Feb 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
question Needs clarification by involved users / reviewers 🗣️ locale:de Resources addressing "German / Deutsch" language 🗣️ locale:el Resources addressing "Greek / Hellenic / ελληνικά" language 🗣️ locale:en Resources addressing "English" language 🗣️ locale:es Resources addressing "Spanish / español" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:vi Resources addressing "Vietnamese / Tiếng Việt" language 🗣️ locale:zh Resources addressing "Chinese" language
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Homogenize governance (CoC, CONTRIBUTING & HOWTO) across files
3 participants