Re: [Website] Putting the docs in the code repos

[Raymond Augé <ra...@liferay.com.INVALID>]

For my part, I'll investigate in the coming weeks.

Thanks David,
Ray


On Wed, Jul 28, 2021 at 8:51 PM David Jencks <da...@gmail.com>
wrote:

> When I set up the new Antora based website, IIRC, Raymond indicated that
> it would be a lot more convenient if the subproject documentation was in
> the same repo as the java code.  I’ve set up a preview for the SCR docs
> over at Felix showing how I’d like to set this up.
>
> The preview is at  https://felix.staged.apache.org/ <
> https://felix.staged.apache.org/>.  Scr is now in the nav under
> subprojects and linked from the table of subprojects.
>
> The minimal README.adoc is visible at
> https://github.com/djencks/felix-dev/tree/adoc-preview/scr <
> https://github.com/djencks/felix-dev/tree/adoc-preview/scr>. Note that
> here GitHub is rendering AsciiDoc.  The source scr website content is at
> https://github.com/djencks/felix-dev/blob/adoc-preview/scr/docs/modules/ROOT/pages/subprojects/scr.adoc
> <
> https://github.com/djencks/felix-dev/blob/adoc-preview/scr/docs/modules/ROOT/pages/subprojects/scr.adoc
> >
>
> The principle is that for each subproject, subproject-related website
> content would be in the code repo under
> <subproject>/docs/modules/ROOT/pages/… There are some possible refinements,
> but if this seems like a good idea I’d suggest starting with a simple move
> of the existing content.
>
> Thoughts?
>
> David Jencks



-- 
*Raymond Augé* (@rotty3000)
Senior Software Architect *Liferay, Inc.* (@Liferay)
OSGi Fellow, Java Champion