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.

Sign up for GitHub

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

Jump to bottom

Add badges #6631

Merged
merged 3 commits into from
Dec 6, 2021
Merged

Add badges #6631

merged 3 commits into from
Dec 6, 2021

Conversation

LuigiImVector
Copy link
Member

What does this PR do?

Improve repo

For resources

Description

Added badges on README and CONTRIBUTING (see #5983)

For book lists, is it a book? For course lists, is it a course? etc.

Checklist:

Follow-up

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

@davorpa
Copy link
Member

davorpa commented Dec 2, 2021 •
edited
Loading

I'd preffer all in the same site like in other repos.

CoC badge link doesn't work (404)

@LuigiImVector
Copy link
Member Author

I'd preffer all in the same site like in other repos.

@eshellman what do you think?

@eshellman
Copy link
Collaborator

I'm not a big fan of badges. The introduce a dependency.
For the CC license, if we want a badge we should use the one from Creative Commons. For the "Contributor Covenant", our CoC is "adapted from Contributor Covenant" but we don't use the words "Contributor Covenant" except on the CoC attribution, so I worry that the added language on the README might be confusing.
I would like to move the "Awesome" badge to below the fold. It's nice to have but oddly prominent on our page.

@LuigiImVector
Copy link
Member Author

I removed the CoC badge to avoid confusion. The official CC license badge doesn't have the same height of "awesome" badge:

image

I think that the unofficial badge is ok but if it is not so, I kick it out and leave the "awesome" badge under the title.

@LuigiImVector LuigiImVector added the 👥 discussion This Repo is guided by its community! Let's talk! label Dec 3, 2021
@LuigiImVector LuigiImVector changed the title Added badges Add badges Dec 3, 2021
davorpa
davorpa reviewed Dec 4, 2021
View reviewed changes
docs/CONTRIBUTING.md
@@ -1,6 +1,5 @@
*[Read this in other languages](../README.md#translations)*


Copy link
Member

Choose a reason for hiding this comment

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

Empty line removed 😉

@eshellman eshellman merged commit a16a79b into EbookFoundation:main Dec 6, 2021
@davorpa davorpa mentioned this pull request Dec 9, 2021
Merged
17 tasks
davorpa added a commit that referenced this pull request Jan 3, 2022
@davorpa
format: center repo badges
7fdc28d 
Apply centering proposed at #5983 but not implemented in #6631
@davorpa davorpa mentioned this pull request Jan 3, 2022
Merged
2 tasks
eshellman pushed a commit that referenced this pull request Jan 3, 2022
@davorpa
format: center repo badges (#6662)
f36fd03 
Apply centering proposed at #5983 but not implemented in #6631
davorpa added a commit to davorpa/free-programming-books that referenced this pull request Jan 22, 2022
@davorpa
Merge EbookFoundation#6631 upstream/main commit into docs/contributin…
0e88060 
…g/sync/1

* Add repo badges (see EbookFoundation#5983)

(cherry picked from a16a79b solving merge conflict)
davorpa added a commit to davorpa/free-programming-books that referenced this pull request Jan 22, 2022
@davorpa
Merge EbookFoundation#6662 upstream/main commit into docs/contributin…
ca6a4d9 
…g/sync/1

* Apply centering proposed at EbookFoundation#5983 but not implemented in EbookFoundation#6631

(cherry picked from commit f36fd03)
eshellman pushed a commit that referenced this pull request Feb 3, 2022
@davorpa
docs(contributing): Homogenize format across translated files (#6625)
84438cb 
* 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: e83220a

* 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: 31c776c

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

- 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

* 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 d775cb3#commitcomment-59537594

#5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb:

d775cb3#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 #5803

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

Fix over #5449 and commit 3c42c36

(cherry picked from commit 59ebfe3)

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

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

PR: #5554
Commit: e629db6

Affected lines: 
- 18bb745#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // e629db6#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4
- 18bb745#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // e629db6#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7
- 18bb745#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // e629db6#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13
- 18bb745#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // e629db6#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45

* docs(contributing): use relative urls EN

Via #6614

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

Via #6614

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

* Add repo badges (see #5983)

(cherry picked from a16a79b solving merge conflict)

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

* Apply centering proposed at #5983 but not implemented in #6631

(cherry picked from commit f36fd03)

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

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

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

(cherry picked from commit de2f319)
@davorpa davorpa mentioned this pull request Feb 6, 2022
Merged
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davorpa davorpa davorpa left review comments

Assignees
No one assigned
Labels
👥 discussion This Repo is guided by its community! Let's talk!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@LuigiImVector @davorpa @eshellman