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: Homogenize governance (CoC, CONTRIBUTING & HOWTO) across files #6590

Closed
9 tasks done
Tracked by #5762
davorpa opened this issue Nov 3, 2021 · 9 comments · Fixed by #6625, #6724, #6700, #6614 or #6719
Closed
9 tasks done
Tracked by #5762

docs: Homogenize governance (CoC, CONTRIBUTING & HOWTO) across files #6590

davorpa opened this issue Nov 3, 2021 · 9 comments · Fixed by #6625, #6724, #6700, #6614 or #6719
Assignees
Labels
PR requested Issues that can be addressed with a new PR 🗣️ translations Issues or PRs addresing translations

Comments

@davorpa
Copy link
Member

davorpa commented Nov 3, 2021

Local branch

@davorpa davorpa self-assigned this Nov 3, 2021
@davorpa davorpa changed the title Complete with new added files, format and alphabetize first paragraph (the language list). CONTRIBUTING & HOWTO docs: Complete gobernance crosslinks: CoC, CONTRIBUTING & HOWTO Nov 3, 2021
@davorpa davorpa changed the title docs: Complete gobernance crosslinks: CoC, CONTRIBUTING & HOWTO docs: Complete gobernance (CoC, CONTRIBUTING & HOWTO) crosslinks Nov 3, 2021
@davorpa davorpa changed the title docs: Complete gobernance (CoC, CONTRIBUTING & HOWTO) crosslinks docs: Homogenize gobernance (CoC, CONTRIBUTING & HOWTO) across files Nov 4, 2021
@eshellman
Copy link
Collaborator

I'll prepare a PR that

  • moves all the instructions files into a docs directory (is that the best name?)
  • removes crosslinks from each translated file and adds them to a docs index page so new files only need to add a link in one place.

@eshellman eshellman changed the title docs: Homogenize gobernance (CoC, CONTRIBUTING & HOWTO) across files docs: Homogenize governance (CoC, CONTRIBUTING & HOWTO) across files Nov 15, 2021
@davorpa
Copy link
Member Author

davorpa commented Nov 15, 2021

I'll prepare a PR that

  • moves all the instructions files into a docs directory (is that the best name?)
  • removes crosslinks from each translated file and adds them to a docs index page so new files only need to add a link in one place.

See this note in chore posted by you: #6164 (comment)

@eshellman
Copy link
Collaborator

so using "docs" works?

@davorpa davorpa added the PR requested Issues that can be addressed with a new PR label Feb 11, 2022
davorpa added a commit to davorpa/free-programming-books that referenced this issue Feb 13, 2022
@davorpa
Copy link
Member Author

davorpa commented Feb 15, 2022

@EbookFoundation/reviewers last step. What do you think about this HowTo's homogeneization?

Performed Tasks:

  • Add H1 header
  • Read this ... right alignmements
  • Split a bit first paragraph to highlight welcome.
  • Introduce Pull Request acronym.
  • Trademark typos: GitHub, YouTube, Pull Request
  • Update GitHub links urls. help/guides subdomain was moved to docs so a 301 Redirect is skipped.
  • Details block added, with center align. When clicked, the contributor graphs are toggled.
  • Some bolds to highlight common 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.

image

It's ok? Aproved to continue apply into the other files?

davorpa added a commit to davorpa/free-programming-books that referenced this issue Feb 15, 2022
- 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#6590
@davorpa davorpa added the 🗣️ translations Issues or PRs addresing translations label Feb 15, 2022
@SethFalco
Copy link
Sponsor Member

SethFalco commented Feb 15, 2022

I think this looks pretty nice, but unfortunately, you may want to test it in the mobile app.

I don't think things like the <details> tag work there. (Bear in mind when I tested was over a year ago.)

We could always ignore that technically, since I'd consider that a bug on GitHub's side, though. (Markdown is Markdown, and should work regardless of client.)

@davorpa
Copy link
Member Author

davorpa commented Feb 15, 2022

I think this looks pretty nice, but unfortunately, you may want to test it in the mobile app.

I don't think things like the <details> tag work there. (Bear in mind when I tested was over a year ago.)

We could always ignore that technically, since I'd consider that a bug on GitHub's side, though. (Markdown is Markdown, and should work regardless of client.)

https://davorpa.github.io/free-programming-books/ Tested on a Kindle Fire EReader and a Samsumg S5 (Android 6.1). It works as expected 4x4 in both environments: GitHub Preview, GitHub Pages. In anyway, the previous link "large, growing" points to same graph

@SethFalco
Copy link
Sponsor Member

Just checking, you tested in the GitHub Mobile App?
https://play.google.com/store/apps/details?id=com.github.android&hl=en_US&gl=US

@davorpa
Copy link
Member Author

davorpa commented Feb 15, 2022

Just checking, you tested in the GitHub Mobile App?
https://play.google.com/store/apps/details?id=com.github.android&hl=en_US&gl=US

yes. it works as well.

Closed Open
Screenshot_20220215-152254.png Screenshot_20220215-152337.png

@eshellman
Copy link
Collaborator

on the whole, I think this looks great.
I'm ambivalent about monospacing "Free-Programming-Books". The name travels outside of the repo to places where it's not possible (or just more work for me) to monospace it - twitter, the Free Ebook Foundation website, and most particularly, the HTML presentation on github. I've managed to keep the dashes intact, mostly. So while monospacing looks good here, I prefer to use less code-y version.
Have commented in the PR on the text that reveals the usage graph.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.