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

Bad target url documenting fpb-lint.yml since CONTRIBUTINGs were moved to docs folder #6721

Closed
davorpa opened this issue Feb 13, 2022 · 2 comments · Fixed by #6722 or #6719
Closed
Assignees
Labels
🐛 BUG Confirmed bugs, normally at GitHub Pages good first issue A good starting point for newcomers PR requested Issues that can be addressed with a new PR

Comments

@davorpa
Copy link
Member

davorpa commented Feb 13, 2022

There are a bug present in all CONTRIBUTING files since were moved to ./docs/ folder pulled by #6614.

image

How to address this? The best way is always use a relative URL so patch the url markdown of each fpb-lint.yml reference with...

[`.github/workflows/fpb-lint.yml`](../.github/workflows/fpb-lint.yml)

I can't believe it how I didn't detect it in #6625 😟

Originally posted by @davorpa in #6719 (comment)

Notes

Start work after merge #6719

LuigiImVector added a commit to LuigiImVector/free-programming-books that referenced this issue Feb 13, 2022
@davorpa davorpa added good first issue A good starting point for newcomers help wanted Needs help solving a blocked / stucked item 🐛 BUG Confirmed bugs, normally at GitHub Pages labels Feb 13, 2022
@davorpa davorpa changed the title bug(contributing): Bad target url in since were moved to docs folder bug(contributing): Bad target url documenting fpb-lint.yml since were moved to docs folder Feb 13, 2022
@RishiKumarRay
Copy link

@davorpa can i raise a PR fixing this?

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

davorpa commented Feb 13, 2022

@davorpa can i raise a PR fixing this?

Sorry @RishiKumarRay , it's currently implemented by @LuigiImVector and me as you can see in the issue timeline

@davorpa davorpa removed the help wanted Needs help solving a blocked / stucked item label Feb 13, 2022
@davorpa davorpa changed the title bug(contributing): Bad target url documenting fpb-lint.yml since were moved to docs folder Bad target url documenting fpb-lint.yml since CONTRIBUTINGs were moved to docs folder Feb 13, 2022
eshellman pushed a commit that referenced this issue Feb 13, 2022
* fix(docs): Bad target url #6721

* fix(docs): Bad target url #6721
eshellman pushed a commit that referenced this issue Feb 22, 2022
)

* Merge #5752 Indonesian CONTRIBUTING translation

Vía #6590
Vía #5762
Recovered from PR #5752 requested by @reskimulud

Co-authored-by: Reski Mulud Muchamad <[email protected]>

* 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 #6721 in CONTRIBUTING-id.md

Co-authored-by: ImVector <[email protected]>

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

Co-authored-by: Reski Mulud Muchamad <[email protected]>
Co-authored-by: ImVector <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 BUG Confirmed bugs, normally at GitHub Pages good first issue A good starting point for newcomers PR requested Issues that can be addressed with a new PR
Projects
None yet
3 participants