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

format: syntax of in-process anotation should be *(:construction: in process)* #7036

Merged

Conversation

davorpa
Copy link
Member

@davorpa davorpa commented Aug 25, 2022

What does this PR do?

Improve repo

For resources

Description

The most common syntax seen for each resource annotations across files are *(bla bla bla)* where the kursive format wraps parenthesis

Regex: ((\*[^\*]+\*)|(_[^_]+_))

So:

  • change from (:construction: *in process*) to *(:construction: in process)*
  • fixes some of resources with this annotation but without it representative icon (*-id.md).
  • translate note text there where there was context previously.

Checklist:

  • Read our contributing guidelines.
  • Include author(s) and platform where appropriate.
  • Put lists in alphabetical order, correct spacing.
  • Add needed indications (PDF, access notes, under construction).
  • Used an informative name for this pull request.

Follow-up

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

from (:construction: *in process*)
to   *(:construction: in process)*
- Applied note `*(:construction: in process)*` translating `in process` to underlying language there where we have previous translated text
- Used regex to detect most of notes: `((\*[^\*]+\*)|(_[^_]+_))`
@davorpa davorpa self-assigned this Aug 25, 2022
@davorpa davorpa added the conflicts Conflict(s) need to be resolved label Aug 25, 2022
@davorpa

This comment was marked as outdated.

Solve conflicts with branch 'upstream/main' until this PR/commit adding theirs resources too behind conflictive hunk

Format incomming resources with new notation too
@davorpa davorpa removed the conflicts Conflict(s) need to be resolved label Aug 25, 2022
@eshellman eshellman added the conflicts Conflict(s) need to be resolved label Aug 25, 2022
@davorpa davorpa removed the conflicts Conflict(s) need to be resolved label Aug 25, 2022
@davorpa davorpa changed the title format: syntax of in-process anotation should be `*(:construction: in process)* format: syntax of in-process anotation should be *(:construction: in process)* Aug 25, 2022
@davorpa davorpa added 🗣️ locale:en Resources addressing "English" language 🗣️ locale:es Resources addressing "Spanish / español" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:de Resources addressing "German / Deutsch" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:zh Resources addressing "Chinese" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:el Resources addressing "Greek / Hellenic / ελληνικά" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:pl Resources addressing "Polish / polski" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:ar Resources addressing "Arabic / العربية" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:vi Resources addressing "Vietnamese / Tiếng Việt" language 🗣️ locale:tr Resources addressing "Turkish / Türkçe" language 🗣️ locale:fa_IR Resources addressing "Persian / Farsi (Iran) / فارسى" language labels Aug 27, 2022
@eshellman
Copy link
Collaborator

I see, so this is meant to align archived and in process? We'll need to play around with this / look at the resulting json.

@davorpa
Copy link
Member Author

davorpa commented Sep 6, 2022

I see, so this is meant to align archived and in process? ...

Yes, sir. Although I also see some of LeanPub notes wrapping all in kursive and others only some parts. Sure there are more data gardening to do 😟 to our oldies eyes.

Since access notes have cardinality of 0-1 and notes 0-n, I propose merge all in the same collection to simplify logic. It's posible? It's great? I don't know, too much newbie to understand the scope.

If someone ask me for the full normalized format I response with:

TITLE_LINK - CREATOR1, ..., CREATORn (FORMAT1, ..., FORMAT2..n?+LINK?) (COURSE_PLATFORM?) *(NOTE1)*... *(NOTEn)*

where AST tokens are:

  • TITLE_LINK: Normal title + year/version for historical books + main link
  • FORMAT1: main format, link in the resource title
  • FORMATn?+LINK?: rest of formats as multiformat syntax with optional links
  • CREATOR: ROLE? CREATOR_FULLNAME
  • ROLE: optional, not necesary for principal authors. Values: trl.: (traducer)... https://loc.gov/marc/relators/relaterm.html
  • meaningfull notes have a emoji prefix. E.g. archived, in_process...

... We'll need to play around with this / look at the resulting json.

How to play with the parser pointing to my forked repo instead of against the upstream?

@eshellman
Copy link
Collaborator

I will work on this, but probably not till next week

@davorpa davorpa added 👀 Needs Review Is this really a good resource? Reviews requested. waiting for changes PR has been reviewed and changes/suggestions requested labels Sep 7, 2022
@davorpa davorpa marked this pull request as draft September 8, 2022 08:49
@davorpa
Copy link
Member Author

davorpa commented Sep 17, 2022

There are new addings in

Remember replace them with the new format if both PRs are accepted

@davorpa davorpa added the conflicts Conflict(s) need to be resolved label Sep 17, 2022
@davorpa
Copy link
Member Author

davorpa commented Sep 17, 2022

Conflicts are with #7065 with moves Vim section to -subjects.md file.

Remember in that file apply new formatting on resolve conficts

…es to solve conflicts

Cherry pick until commit 4d67825 + 0a83d41
@davorpa davorpa removed the conflicts Conflict(s) need to be resolved label Sep 17, 2022
@github-actions github-actions bot added the conflicts Conflict(s) need to be resolved label Oct 19, 2022
@github-actions
Copy link

Oh no 😟! Conflicts have been found.

Please 🙏, take a moment and address the merge conflicts of your pull request before we can evaluate it again.

Thanks in advance for your effort and patience ❤️!

@github-actions github-actions bot removed the conflicts Conflict(s) need to be resolved label Nov 15, 2022
@github-actions github-actions bot added the conflicts Conflict(s) need to be resolved label Jan 10, 2023
@github-actions
Copy link

Oh no 😟! Conflicts have been found.

Please 🙏, take a moment and address the merge conflicts of your pull request before we can evaluate it again.

Thanks in advance for your effort and patience ❤️!

@eshellman eshellman marked this pull request as ready for review November 22, 2023 14:31
@github-actions github-actions bot removed the conflicts Conflict(s) need to be resolved label Nov 22, 2023
Copy link

Linter failed, fix the error(s):

free-programming-books/books/free-programming-books-subjects.md
833:1-850:100  warning  Incorrect number of blank lines between last section and next heading  blank-lines-1-0-2  remark-lint

@github-actions github-actions bot added the linter error Please, correct build errors found by linter! label Nov 22, 2023
Copy link

Linter failed, fix the error(s):

free-programming-books/books/free-programming-books-subjects.md
833:1-850:100  warning  Incorrect number of blank lines between last section and next heading  blank-lines-1-0-2  remark-lint

Co-authored-by: Leithen <lcrider@cvent.com>
@github-actions github-actions bot removed the linter error Please, correct build errors found by linter! label Nov 29, 2023
@eshellman eshellman merged commit 59e4fba into EbookFoundation:main Nov 29, 2023
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👀 Needs Review Is this really a good resource? Reviews requested. 🗣️ locale:ar Resources addressing "Arabic / العربية" language 🗣️ locale:cs Resources addressing "Czech / čeština / český jazyk" language 🗣️ 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:fi Resources addressing "Finnish / suomi / suomen kieli" language 🗣️ locale:fil Resources addressing "Filipino" language 🗣️ locale:fr Resources addressing "French / français" language 🗣️ locale:hi Resources addressing "Hindi / हिन्दी" language 🗣️ locale:hu Resources addressing "Hungarian / magyar / magyar nyelv" language 🗣️ locale:id Resources addressing "Indonesian" language 🗣️ locale:it Resources addressing "Italian / italiano" language 🗣️ locale:ko Resources addressing "Korean / 한국어 [韓國語]" language 🗣️ locale:pl Resources addressing "Polish / polski" language 🗣️ locale:pt Resources addressing "Portuguese / Brazilian" language 🗣️ locale:ru Resources addressing "Russian / Русский язык" language 🗣️ locale:sk Resources addressing "Slovak / slovenčina" language 🗣️ locale:tr Resources addressing "Turkish / Türkçe" language 🗣️ locale:vi Resources addressing "Vietnamese / Tiếng Việt" language 🗣️ locale:zh Resources addressing "Chinese" language waiting for changes PR has been reviewed and changes/suggestions requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants