search

blue-build / modules

BlueBuild standard modules used for building your Atomic Images
Apache License 2.0
22 stars 26 forks source link

docs(files): re-add file documentation #205

Closed alexispurslane closed 2 months ago

alexispurslane commented 2 months ago

Fixes #204

Not sure how much detail you wanted, I hope this helps.

xynydev commented 2 months ago

Oh, this is actually good. I was planning to copy it from git history, the previous page should be there in this repo's history. Maybe you can look for it here and add the missing pieces.

alexispurslane commented 2 months ago

Oh, this is actually good. I was planning to copy it from git history, the previous page should be there in this repo's history. Maybe you can look for it here and add the missing pieces.

sure, ill take a look

alexispurslane commented 2 months ago

@xynydev okay, I looked up the old documentation and added any parts that were missing.

xynydev commented 2 months ago

That's great! Thanks a lot! Could you also go ahead and add the docs to the modules.json in the root of this repo for me?

alexispurslane commented 2 months ago

That's great! Thanks a lot! Could you also go ahead and add the docs to the modules.json in the root of this repo for me?

oh yeah, didn't know I needed to do that, no prob

fiftydinar commented 2 months ago

@xynydev What do you think, should we address this issue too here?

https://github.com/blue-build/modules/issues/189

Useful link for the issue above, to make writing faster: https://docs.fedoraproject.org/en-US/fedora-silverblue/technical-information/#filesystem-layout

alexispurslane commented 2 months ago

@fiftydinar id be more than happy to add that caveat to the docs too. if there's one thing that doesn't require my brain to be on to do, it's writing docs, so my ongoing migraine is no obstacle :P

fiftydinar commented 2 months ago

@alexispurslane Great, because sometimes, writing docs can be more tiring than coding for me :D

alexispurslane commented 2 months ago

How do I create a warning box like the note box?

fiftydinar commented 2 months ago

How do I create a warning box like the note box?

I know that :::caution TEXT TO INPUT ::: works, which you can check here as an example for akmods module: https://github.com/blue-build/modules/blob/main/modules/akmods/README.md

:::warning is maybe working too, but I find "caution" & "warning" very similar if not the same.

alexispurslane commented 2 months ago

Okay added the extra information!

fiftydinar commented 2 months ago

Looks good to me!

However, @xynydev manages the website, so he will know if syntax is good, if there is something to fix in text layout & similar things.

So his review is also needed.

alexispurslane commented 2 months ago

Sounds good. I am, again, writing this with brain fog, so im always happy for more review, in case anything is stated in an unclear manner or something.

xynydev commented 2 months ago

Thanks a lot!

I'd be more than happy to add that caveat to the docs too. if there's one thing that doesn't require my brain to be on to do, it's writing docs, so my ongoing migraine is no obstacle :P

Great, because sometimes, writing docs can be more tiring than coding for me :D

If writing docs comes so naturally to you, we would really appreciate more contributions from you! I love writing docs, but it takes a full day of walking around (so that my brain works better) to come up with a coherent structure and sentences for documentation pages. Compared to that, a lot of coding is just brainlessly typing away, lol.