search

config-files-api / config_files_api

base gem providing infrastructure for specific configuration files models.
MIT License
5 stars 4 forks source link

Documentation #20

Closed mchf closed 7 years ago

mchf commented 7 years ago

TBD: sync blog.md and design.md again once the last one is in final state --- DONE

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling d9fb188547eda40d4c4acf31a6e8e6292460ee00 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 9467f1f78aacfb1429fe211756eea75d9348af7f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 9467f1f78aacfb1429fe211756eea75d9348af7f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 9467f1f78aacfb1429fe211756eea75d9348af7f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 9467f1f78aacfb1429fe211756eea75d9348af7f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2afae83d53ab24afbe010fafceb7034205365c67 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2afae83d53ab24afbe010fafceb7034205365c67 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling fd84f307fd51b848d40308f40655e3c307b24cbd on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

mchf commented 7 years ago

@mvidner Could you please also check it?

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling e295041cf2411c72fa3290335da128079e28b1a1 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 30bf2c77c0c5cd38d7440a0184f4a463b8ff293f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 21107e78be924270376986cc3b62e4280bc150d2 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

mvidner commented 7 years ago

Thanks! Some preliminary notes:

  1. We already have a YARD setup that will create a doc directory. Please move these files there and adjust .yardopts to include design.md in the rendered docs.
  2. Please use a spell checker. You have actually made me look up how to do it in Emacs: M-x flyspell-buffer (checks the whole file once) and M-x flyspell-mode (will check around text being edited).
mvidner commented 7 years ago

Please improve the design document by giving the existing structure clear names:

Instead of "1st layer, 2nd layer, 3rd layer", use "Bottom layer: Pasta, Middle layer: Salami, Top layer: Peppers (fixme, use actual ingredients)"

In the limitations section, make 3 subsections with short descriptive titles too.

mchf commented 7 years ago

@mvidner almost all (but hyperlinks in design) comments were integrated.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 82c48f04fa79136e2df234046105ab710f48dbe5 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling a7895dd69f03a3aef9a47aac7605366c668447ac on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 3b032369ce28371f3e838d7ef5a082cae07bb702 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling ab6c8620ded7c70180da801bb3f1c382968a546c on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling ab6c8620ded7c70180da801bb3f1c382968a546c on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 569d690708e1fa7ae65ae958293cb51a3ff69dec on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 569d690708e1fa7ae65ae958293cb51a3ff69dec on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling cf45a8348e8911429ed1ef5d68533713b080a51f on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

mvidner commented 7 years ago

Thanks! Are you adding the class links to design.md? Don't forget to spell check that file too.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2092bf1815d267b2f03f6ad90e47dc1bf0aaae89 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2092bf1815d267b2f03f6ad90e47dc1bf0aaae89 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2092bf1815d267b2f03f6ad90e47dc1bf0aaae89 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 2092bf1815d267b2f03f6ad90e47dc1bf0aaae89 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

mchf commented 7 years ago

@mvidner added links even into design.md

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling a90fcc912fb5ec55337cb9bce9f3ddc05fedc913 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling a90fcc912fb5ec55337cb9bce9f3ddc05fedc913 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling a90fcc912fb5ec55337cb9bce9f3ddc05fedc913 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling a90fcc912fb5ec55337cb9bce9f3ddc05fedc913 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 813663269a805963d85b9c44d7eff730acf6f643 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 813663269a805963d85b9c44d7eff730acf6f643 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling e74d4d78d371d34642de4bafd7f1f35f338cddc5 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling e74d4d78d371d34642de4bafd7f1f35f338cddc5 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling e74d4d78d371d34642de4bafd7f1f35f338cddc5 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

mchf commented 7 years ago

Thanks for the reviews

mchf commented 7 years ago

I've just removed the blog draft as it was already published: https://lizards.opensuse.org/2017/05/17/cfa-config-files-api-at-a-glance/

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 63348cf5795183275d49b14549f35c04215a82d3 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 63348cf5795183275d49b14549f35c04215a82d3 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 63348cf5795183275d49b14549f35c04215a82d3 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 88.105% when pulling 63348cf5795183275d49b14549f35c04215a82d3 on mchf:doc into 142981bcdf7a144436beca464772eb4c4ef404c5 on config-files-api:master.