adambard / learnxinyminutes-docs

Code documentation written as code! How novel and totally my idea!
https://learnxinyminutes.com/
Other
11.4k stars 3.32k forks source link

[many/many] WE NEED YOU! #2832

Closed adambard closed 6 years ago

adambard commented 7 years ago

...to help smash these fiddly bugs relating to various docs' yaml frontmatter!

Comment below if you're in a bug-fixy mood and I'll give you commit access.

Checking ../source/docs/awk.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/bf.html.markdown
WARN: Filename missing

Checking ../source/docs/bg-bg/perl-bg.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/c++.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/d.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/de-de/java-de.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/es-es/bf-es.html.markdown
WARN: Filename missing

Checking ../source/docs/es-es/csharp-es.html.markdown
ERROR: Error in frontmatter

Checking ../source/docs/es-es/git-es.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/es-es/sass-es.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/es-es/xml-es.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/fa-ir/bf-fa.html.markdown
WARN: Filename missing

Checking ../source/docs/fr-fr/css-fr.html.markdown
WARN: Filename missing

Checking ../source/docs/fr-fr/haml-fr.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/fr-fr/php.html.markdown
WARN: Filename missing

Checking ../source/docs/fr-fr/vim.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/fr-fr/yaml-fr.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/haskell.html.markdown
WARN: Filename missing

Checking ../source/docs/it-it/bf-it.html.markdown
WARN: Filename missing

Checking ../source/docs/it-it/json-it.html.markdown
WARN: Filename missing

Checking ../source/docs/it-it/python-it.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/ko-kr/bf-kr.html.markdown
WARN: Filename missing

Checking ../source/docs/lt-lt/tmux-lt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/nl-nl/bf.html.markdown
WARN: Filename missing

Checking ../source/docs/ocaml.html.markdown
WARN: Filename missing

Checking ../source/docs/pl-pl/bf-pl.html.markdown
WARN: Filename missing

Checking ../source/docs/pl-pl/haskell-pl.html.markdown
WARN: Filename missing

Checking ../source/docs/pl-pl/perl-pl.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/pt-br/bf.html.markdown
WARN: Filename missing

Checking ../source/docs/pt-br/c++-pt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/pt-br/groovy-pt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/pt-br/hy-pt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/pt-br/javascript-pt.html.markdown
WARN: Filename missing

Checking ../source/docs/pt-br/swift-pt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/pt-pt/bf.html.markdown
WARN: Filename missing

Checking ../source/docs/purescript.html.markdown
WARN: Filename missing

Checking ../source/docs/qt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/README.markdown
WARN: Could not read frontmatter.

Checking ../source/docs/ru-ru/bf.html.markdown
WARN: Filename missing

Checking ../source/docs/ru-ru/haskell-ru.html.markdown
WARN: Filename missing

Checking ../source/docs/ru-ru/html-ru.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/ru-ru/java-ru.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/rust-pt.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/smalltalk.html.markdown
WARN: Filename missing

Checking ../source/docs/standard-ml.html.markdown
WARN: Filename missing

Checking ../source/docs/sv-se/brainfuck-sv.html.markdown
WARN: Filename missing

Checking ../source/docs/ta_in/json-ta.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/tcsh.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/tr-tr/dynamic-programming-tr.html.markdown
WARN: Filename missing

Checking ../source/docs/uk-ua/java-ua.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/vi-vn/html-vi.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/vi-vn/python3-vi.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/vi-vn/ruby-vi.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/zh-cn/bf-cn.html.markdown
WARN: Filename missing

Checking ../source/docs/zh-cn/livescript-cn.html.markdown
ERROR: Filename lacks language code suffix

Checking ../source/docs/zh-cn/matlab-cn.html.markdown
WARN: Filename missing
prertik commented 7 years ago

Sure. Would definitely help to fix these bugs.

vendethiel commented 7 years ago

Well, a PR would work as well.

prertik commented 7 years ago

@vendethiel Yeah, but commit access sounds cool!

adambard commented 7 years ago

PRs work as well, but more collaborators make lighter work :)

prertik commented 7 years ago

I think this issue is no more. Can you review it @adambard ?

prertik commented 7 years ago

I ran the python script frontmatter_checker. There were still many bugs. This test checks for error as a whole. So, for the en-language docs, it's asking for category, filename with language scope and all. To pass the whole test categories should be made and every docs should have exact format.