metafacture / metafacture-documentation

The central place for documentation about metafacture
http://metafacture.github.io/metafacture-documentation/
Apache License 2.0
3 stars 3 forks source link

Add how to update and publish flux-commands.md #15

Closed dr0i closed 2 years ago

dr0i commented 2 years ago

In order of improving the documentation this should help to understand how to produce an improved flux-commands.md.

TobiasNx commented 2 years ago

Content looks good, but I don't think that this is the right spot to publish it. Perhaps here? https://github.com/metafacture/metafacture-core/wiki/Code-Quality-and-Style#code-documentation

dr0i commented 2 years ago

Hm, maybe - let's ask for opinion from @fsteeg. My first thought was "flux-command.md is stored in this repo, so let's document here how to build it properly".

fsteeg commented 2 years ago

I think here is the right place, since it's published here.

(Also this is a temporary state, see https://github.com/metafacture/metafacture-core/issues/368.)

TobiasNx commented 2 years ago

okay then go for it +1

dr0i commented 2 years ago

Also this is a temporary state

you mean "although". If metafacture/metafacture-core#368 is ~ready~ resolved we could (should?) move this how-to to https://github.com/metafacture/metafacture.github.io/docs/main .

Merged for the time being and closed.

fsteeg commented 2 years ago

you mean "although".

No, I meant it both in support of not moving it elsewhere (since it's temporary anyway), and as in "let me add that".

dr0i commented 2 years ago

I don't understand. Let's clarify. What do you mean exactly by "this is a temporary state"? I thought you meant this repo (metafacture-documentation), while the future ordinary place would be in metafacture.github.io/docs/main . Or should the flux-commands.md be hold in two (three?) places - here and in metafacture.github.io/docs/main[releases...] ?

fsteeg commented 2 years ago

(Clarified in our meeting, we'll see where the file will be in the future, but for now it's good here)