[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
On 03/11/2019 05:57 PM, Mario Loriedo wrote:
Robert it looks like a good plan. When you say "All teams can continue to
submit new content into it." do you mean contributing to the google doc or
the the adoc in the new branch?
As soon as the doc is in Git, then start contributing there.
However, if teams find it easier to create the initial content in the Google Doc, then we can continue using it -- but strict guidelines would need to be put in place to ensure everyone is clear on which parts are still WIP in the Gdoc; otherwise it would become a big mess (reviewed and reformatted content in Git could become obsolete if teams continued editing that same content in the Gdoc).
Robert
cc @Gorkem Ercan <gercan@xxxxxxxxxx>
On Mon, Mar 11, 2019 at 5:29 PM Robert Kratky <rkratky@xxxxxxxxxx> wrote:
Hi all,
(CC'ing che-dev to keep it in the open.)
Thanks for putting this together, Alex. I would suggest the following:
1) Let's take this big adoc file and put it in a new branch in the
che-docs repo.
2) I will set up some primitive automatic build job for it, so that we can
have a better rendering than what GitHub does. (Also configure building of
a TOC.)
3) Someone from the docs team will split the doc into section files to
make contributing (and understanding the doc structure) easier. All teams
can continue to submit new content into it.
4) As sections get reviewed and become (more or less) ready for
publication, docs team will take them (when we get the go-ahead that a
particular section is technically correct) and put them into the che-7
structure on eclipse.org/che/docs/ -- with a link in the orig. doc, so
that people know where to continue working on that part of the doc.
5) This process should result in gradual integration of all completed Che
7 docs into the eclipse.org/che/docs/ site -- while the orig. working
adoc will continue to shrink and eventually disappear when all areas have
been documented.
Wdyt?
Regards,
Robert
On 03/11/2019 04:35 PM, Stevan LeMeur wrote:
Nice, thanks Alex !
I'm a bit worry that it will get a little bit confusing to read that
"long
document", but at least the content is there and we can start splitting
it
into different md files.
@Robert Kratky <rkratky@xxxxxxxxxx> + @Mario Loriedo <
mloriedo@xxxxxxxxxx> :
What do you think about it?
On Mon, Mar 11, 2019 at 4:26 PM Oleksandr Garagatyi <ogaragat@xxxxxxxxxx
wrote:
Hello. Following up on the discussion we had today about publishing Che
7
docs in the current state.
Indeed writing all the docs from scratch would be very time consuming.
Since we don't have needed capacity to do that we can start from just
converting current state into a single Asciidoc page. Then we can
request
to do all the changes in that document.
And when Docs team has time they can restructure document in a way it
was
intended to be structured.
I played with converters a bit and here is what I ended up with:
https://github.com/garagatyi/che-docs/blob/currentChe7DocsState/src/main/pages/che-7/singledoc/che7singledoc.adoc
There are conversion issues but mostly it is fine: some formatting in
place, images, tables , etc.
This can speed up creation of the docs significantly.
OLEKSANDR GARAGATYI
