Commit Graph

66 Commits

Author SHA1 Message Date
ImVector
a75cf7641f
docs(CONTRIBUTING): Apply to the rest of the CONTRIBUTING files ()
* docs(CONTRIBUTING): Apply  to the rest of the CONTRIBUTING files

* Update docs/CONTRIBUTING-es.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update docs/CONTRIBUTING-es.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update docs/CONTRIBUTING-es.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update docs/CONTRIBUTING-es.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* doc: translate to zh_TW version

* fix: add the link anchor

* translate the changes to the de version

* Update docs/CONTRIBUTING-fr.md

Co-authored-by: lorrding <mathias.berthonneau@gmail.com>

* Update docs/CONTRIBUTING-fr.md

Co-authored-by: lorrding <mathias.berthonneau@gmail.com>

* Update docs/CONTRIBUTING-fr.md

Co-authored-by: lorrding <mathias.berthonneau@gmail.com>

* Update CONTRIBUTING-fa_IR.md

* Fix the wrong link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
Co-authored-by: alansyue <b123105@gmail.com>
Co-authored-by: Oliver Matla <info@lupinitylabs.com>
Co-authored-by: lorrding <mathias.berthonneau@gmail.com>
Co-authored-by: Amirhossein Mojiri Foroushani <amojiry@gmail.com>
2022-07-14 13:39:46 +02:00
ImVector
0aa949975c
docs(CONTRIBUTING): improve guidelines ()
* docs(CONTRIBUTING): improve guidelines

* docs(CONTRIBUTING): new section

* Update docs/CONTRIBUTING.md

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>

* docs(CONTRIBUTING)

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>

* Update docs/CONTRIBUTING.md

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
2022-06-21 14:15:21 -04:00
David Ordás
6a4db2b978
docs(contributing): Add playground definition ()
* Added playground definition

Added a small definition about programming/coding playgrounds for making it understandable to beginners

* Define what is a playground

Via / completes:
- What's a programming playground? 
- Added playground definition 
- Sentence added under playground 

Thanks @Suman373 for the initial idea.

Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com>

* reword playground definition as suggested

Co-authored-by: Eric Hellman <eric@hellman.net>

Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com>
Co-authored-by: Eric Hellman <eric@hellman.net>
2022-04-12 12:27:59 -04:00
David Ordás
83b3e6b68c
chore: keeping spelling consistencies same. GitHub and YouTube trademarks ()
* keep spelling same. `GitHub`

* keep spelling same. `YouTube`

* Github's reverts and rewordings

* Github's reverts
2022-03-07 10:04:22 -05:00
David Ordás
28ec79103b
docs(howto): Homogenize HowTo's format across translated files ()
* Homogenize HowTo's

- Add H1 header
- `Read this` ... right alignmements
- Split a bit first paragraph to highlight welcome.
- Introduce Pull Request acronym.
- trademarks / typos: GitHub, YouTube, Pull Request
- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Details block added, with center align. When clicked, the contributor graphs is toggled.
- Some bolds to highlight common resources formating issues (like in CONTRIBUTING)
- Repo name in monospace font
- Re-worded last part of 4th paragraph to explain that no new PR is needed to open if there are linter errors or changes are requested. Now it's more clear, I thought.

Via EbookFoundation/free-programming-books#6590

* Rewording to be more meaningful

* Add H1 header + `Read this` ... aligned to right

Via EbookFoundation/free-programming-books#6590

* remove trailing spaces

* Split a bit first paragraph to highlight welcome.

Via EbookFoundation/free-programming-books#6590

* homogenize `1-2` newlines amount between paragraphs

* Update Github documentation links list

- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context

Via EbookFoundation/free-programming-books#6590

* GitHub trademark typos

* YouTube trademark typos

* `Welcome to fpb!` in bold style

* Repo name backticked in monospace font

(non-translatable)

* reword es-en graph summary

* Add a centered details block with graphs about contributions (users vs. time)

Detail blocks are toggleable sections in GitHub

Provided graphs by apiseven:
- Contributor over time Graph
- Monthly Active Contributors graph

* GitHub trademark typos

* Fix pull request typos and introduce it acronym

* Update Github documentation links list

- Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped.
- Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context

The forgot rest addressed on 7ee485bb3b commit
Via 

* Some bolds to highlight common resources formating issues (like in CONTRIBUTING)

* Fix typos suggested by AhmedElTabarani

Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>

* Add paragrah from . Need language translation

* New strings translated to `it` Italian

Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>

* use languages not countries. `in Egyptian Arabic`

* use languages not countries. `in Algerian Arabic`

* remove notes from details block containing graphs about contributions (users vs. time)

* Fix spanish typos

Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>

* Fix korean typos

Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>

* New strings translated to `ar` Arabic

Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>

* New strings translated to `fr` French

Co-authored-by: Loic Beylot <loic.beylot@gmail.com>

Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com>
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
Co-authored-by: Wonjang Son <sondaniel.88@gmail.com>
Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 11:04:55 -05:00
David Ordás
0e9ad7e994
chore: HTML5 anchors compilant <a name= > <a id= ()
* HTML5 anchors compilant `<a name=>` > `<a id=` for books

* HTML5 anchors compilant `<a name=>` > `<a id=` for courses

* HTML5 anchors compilant `<a name=>` > `<a id=` for contribs

* HTML5 anchors compilant `<a name=>` > `<a id=` for casts

* HTML5 anchors compilant `<a name=>` > `<a id=` for cheats

* HTML5 anchors compilant `<a name=>` > `<a id=` for interactives

* HTML5 anchors compilant `<a name=>` > `<a id=` for playgrounds
2022-02-25 11:23:35 -05:00
David Ordás
47bc198769
docs(contributing): Merge with Indonesian translation ()
* Merge  Indonesian CONTRIBUTING translation

Vía 
Vía 
Recovered from PR  requested by @reskimulud

Co-authored-by: Reski Mulud Muchamad <63949402+reski-mulud-muchamad@users.noreply.github.com>

* Homogenize format & indent of code blocks

- 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]

* Homogenize `check_urls=file_to_check`

* use "consistent" unordered list mark and ensure 4-spaces indent .editorconfig param

Solves markdownlint rules:
MD004/ul-style: Unordered list style "consistent"

* Move some punctuation just before any closing brackets after it

* Apply headings `2-1` empty lines lint rule

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

* fix missing anchor aliases

specially ones about Guidelines and Formatting

* Hack highlight IDE/Editors headings+HTML

It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself

* Homogenize Pull Request acronym

* YouTube trademark typos

* filenames in monospace font

* literals/markup texts in monospace font
- `et al.`
- File extensions `.md`
- Protocols: `http`, `https`...
- Notes: LeanPub, require email, StackOverflow, in process, archived

trailing dots in that lines

* Fix  in CONTRIBUTING-id.md

Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>

* HTML5 anchors compilant `<a name=`>`<a id=`

Co-authored-by: Reski Mulud Muchamad <63949402+reski-mulud-muchamad@users.noreply.github.com>
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
2022-02-22 09:35:06 -05:00
ImVector
92f1e7bc10
fix(docs): Bad target url ()
* fix(docs): Bad target url 

* fix(docs): Bad target url 
2022-02-13 15:58:11 -05:00
David Ordás
7a8349abfe
feat: Add docs/readme.md + update crosslinks ()
* complete translate list with the new languages appeared since hacktoberfest

* Create docs/README.md with the translations section

using root README.md as source. Links are adapted to this folder

Address EbookFoundation/free-programming-books#6698

* fix remaining url + translation items

- Portuguese (Portugal)
- Slovak / slovenčina
- Slovenian / slovenščina

Address EbookFoundation/free-programming-books#6698

* fix remaining url + translation items

- Portuguese (Portugal)
- Slovak / slovenčina
- Slovenian / slovenščina

Address EbookFoundation/free-programming-books#6698

* Add inclusiveness `dare to translate...` paragraph

* Add inclusiveness `dare to translate...` paragraph

* Move translations link target url to docs

* move translation links `bs`

* move translations link `en`

* move translations crosslink `es`

* move translations crosslink `fr`

* move translations crosslink `de`

* move translations crosslink `el`

* move translations crosslink `fa_IR`

* move translations crosslink `fil`

* move translations crosslink `it`

* move translations crosslink `pt_BR`

* move translations crosslink `ko`

* move translations crosslink `ru`

* move translations crosslink `id`

* move translations crosslink `zh`

* move translations crosslink `hi`

* move translations crosslink `pl`

* move translations crosslink `uk`

* move translations crosslink `vi`

* move translations crosslink remaining `HOW-To's`

* revert feature moved to 

* Remove the list from the top level. Leave `en` links

* use `previous languages` in root README

* Add more languages lists in root `readme.md`

* fix typo

* fix typo

* Update docs/README.md after translations paragraph

Less text is more

Co-authored-by: Eric Hellman <eric@hellman.net>

* Update README.md after translations paragraph 

Less text is more

Co-authored-by: Eric Hellman <eric@hellman.net>

* Update README.md preface translations paragraph 

Co-authored-by: Eric Hellman <eric@hellman.net>

* fix CONTRIBUTING target url commited at fd2b39151c

* Update docs/README.md preface translations paragraph 

Co-authored-by: Eric Hellman <eric@hellman.net>

* read me! said the boss ^^,

less text is more.

Co-authored-by: Eric Hellman <eric@hellman.net>

* remove "The inclusiveness is one of our targets, so "

Co-authored-by: Eric Hellman <eric@hellman.net>
2022-02-11 12:27:07 -05:00
أحمد الطبراني
6a72370bc8
fix: RTL support for Arabian docs ()
* Add RTL to display it correctly on the website

* add close tag
2022-02-09 10:05:44 -05:00
David Ordás
84438cb1df
docs(contributing): Homogenize format across translated files ()
* docs(contributing): remove trailing spaces

* docs(contributing): Apply headings `2-1` empty lines lint rule

* docs(contributing): Apply headings `2-1` empty lines lint rule

forgotten in previous commit: e83220aa4c

* docs(contributing): Move anchor alias to inside list items

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

This solves markdownlint `MD032/blanks-around-lists` issue

* docs(contributing): Homogenize `1` blank line in nutshell enumeration

* docs(contributing): Homogenize `1` blank line inside Formatting section

* docs(contributing): Ensure `4-spaces` indent `.editorconfig` param

* docs(contributing): Homogenize format & indent of code blocks

- 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]

* docs(contributing): Ensure `4-spaces` indent `.editorconfig` param

Forgotten in commit: 31c776cb52

* docs(contributing): Homogenize format & indent of code blocks

- Simulate `Good` - `Bad` monospace double colon indent inside each one.

Revert commit f9dc719aef only in this file after check non-needs in a deployed web snapshot

* docs(contributing): Use "consistent" unordered list mark

Solves markdownlint rules:
MD004/ul-style: Unordered list style "consistent"

* docs(contributing): Solve `no-space-in-*` lint rules

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

* docs(contributing): Move some punctuation just before any closing brackets after it

* docs(contributing): Hack highlight IDE/Editors headings+HTML

It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself

* docs(contributing): Homogenize Pull Request acronym

* docs(contributing): Fix `GitHub` trademark typos

* docs(contributing): ALLCAPS

* docs(contributing): Git trademark

* docs(contributing): YouTube trademark

* docs(contributing): ISBN acronym

* fix: flag emoji code `en` > `us`

Resolves d775cb34fb (commitcomment-59537594)

: `:en:` emoji flag markup doesn't work. Use `🇺🇸` 🇺🇸 or `🇬🇧` 🇬🇧

d775cb34fb (diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10)

* docs(contributing): Fix fa_IR broken anchors

* docs(contributing): filenames in monospace font

* docs(contributing): Homogenize `check_urls=file_to_check`

* docs(contributing): literals/markup texts in monospace font

- `et al.`
- File extensions `.md`
- Protocols: `http`, `https`...
- Notes: LeanPub, require email, StackOverflow, in process, archived

trailing dots in that lines

* docs(contributing): linkify wayback machine

* docs(contributing): Fix `Leanpub` trademark typos

* chore: Rename `master` to `main` #blacklivesmatter

Resolves EbookFoundation/free-programming-books#5803

* docs(contributing): fix broken ref link to `programming-playgrounds`

Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629e

(cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426)

* docs(contributing): fix repo urls on initial FR translation

- `ElivreFoundation` -> `EbookFoundation`
- `free-programming-livres` ->`free-programming-books`

PR: 
Commit: e629db6b05

Affected lines: 
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45)

* docs(contributing): use relative urls EN

Via 

* docs(contributing): greek. place translations link in right place

Via 

* Merge  upstream/main commit into docs/contributing/sync/1

* Add repo badges (see )

(cherry picked from a16a79b12d solving merge conflict)

* Merge  upstream/main commit into docs/contributing/sync/1

* Apply centering proposed at  but not implemented in 

(cherry picked from commit f36fd03c06)

* format(contributing): Bold 5th nutshell equal zh

* Merge  upstream/main commit into docs/contributing/sync/1

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

(cherry picked from commit de2f31976f)
2022-02-02 20:39:27 -05:00
Charlotte Tan
de2f31976f
fix(docs): Use Kramdown processor ()
* Update _config.yml

* add markdown=1

* add markdown="1"

* add markdown="1"

* remove extra space?

* update url

* try

* undo, wrong branch

* complete removing spaces?

Initial addressed at commit 83b7ee4112

* explicitly use kramdown

* try undo url change

* redoing url change

specifying `markdown: kramdown` explicitly did not change url parsing behavior

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
2022-01-31 11:58:31 -05:00
ImVector
a16a79b12d
Add badges ()
* Added badges

* Fixed bug 

* Removed CoC badge
2021-12-06 10:52:29 -05:00
David Ordás
ee4b9ee1f9
chore: Rename master to main #blacklivesmatter ()
* chore: Rename `master` to `main` #blacklivesmatter

Resolves EbookFoundation/free-programming-books#5803

* docs(contributing): fix broken ref link to `programming-playgrounds`

Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629e

(cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426)

* fix: Complete  upstream/main merge

Over commit: 4d3c9fe11c

Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>

Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
2021-11-23 09:25:57 -05:00
David Ordás
8997e2e99b
chore: complete review of HOWTO in Turkish ()
* fix: url of broken links

Broken due to translation or split in lines

Improves 

* fix: recover repo name

Improves 

* fix: `GitHub` trademark typos

Improves 

* fix: Homogenize Pull Request acronym

Improves 

* fix: Avoid translate trademarks / product names / UI elements

Improves 

* chore: outlinks web accesibility notes

Anotate in which language is written / spoken the content of outlinks

Improves 
2021-11-23 09:25:37 -05:00
Eric Hellman
868d94730a
move the translated documentation files to a docs folder ()
* new branch for misc cleanup

* add item to resolve 

* fix grammar

* re-collate

* centralize all the translation links

* one more

* fix link

* localize labels

* move files

* fix links

* indent in arabic

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* typos

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* remove

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translation

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translation

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* mixed markdown

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* period

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* missing *

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update docs/HOWTO-pl.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update docs/HOWTO-th.md

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translated

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translate

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* lower case

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* typo

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* wording

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translations link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* space

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* space

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* typo

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* Update CONTRIBUTING-de.md

* space

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* parens not brackets

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* add 

* chore: resolve dead code CONTRIB-es

Addressed at https://github.com/EbookFoundation/free-programming-books/pull/6614#commitcomment-60517997

Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277

* chore: use spanish translated text for "translations"

Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277

* chore: DRY. Use markdown link refs as translations target

Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277

* fix: revert removed parens in previous commit 6276a21d85

Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* lint

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* lint

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* lint

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* lint

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* fix link

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* space

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

* translate

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>

Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
2021-11-20 13:25:15 -05:00