aries-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Jencks <david.a.jen...@gmail.com>
Subject Re: The project website
Date Thu, 06 Aug 2020 06:25:13 GMT
I looked at this briefly…
i think the following steps will lead us to a nice Antora site:

1. convert the svn to a git repo
2. translate the .markdown files to asciidoc in place with kramdown-asciidoc asciidoctor/kramdown-asciidoc:
A kramdown ... - GitHubgithub.com › asciidoctor › kramdown-asciidoc <https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&ved=2ahUKEwi6mdCO9oXrAhWwJDQIHYAeCt0QFjAAegQIBRAB&url=https%3A%2F%2Fgithub.com%2Fasciidoctor%2Fkramdown-asciidoc&usg=AOvVaw2sOAmH3_x0kdG3iuFoZ7OX>
(there will be plenty of errors to fix….)
3. Move the content to an Antora structure with some minimal amount of (re)organization.
4. Set up Antora navigation, build, and UI
5. Fix the asciidoc errors.
6. Consider what further reorganization is appropriate, such as moving the docs for (sub)projects
to those subprojects.
7. Figure out how to use the Apache publish-to-git system
8. Refine the UI.

I think it will be simplest if I just do steps 1-4.  

There seems to already be a git aries-site repo that looks abandoned.  Can I move the current
content to a different branch and use that for (1)?

Comments? Objections?

David Jencks


> On Aug 5, 2020, at 11:44 AM, Raymond Auge <raymond.auge@liferay.com.INVALID> wrote:
> 
> https://svn.apache.org/repos/asf/aries/site/trunk/
> 
> - Ray
> 
> On Wed, Aug 5, 2020 at 2:36 PM David Jencks <david.a.jencks@gmail.com>
> wrote:
> 
>> I looked around a little bit and couldn’t find the source for the current
>> website.  Is it hidden somewhere in Apache CMS svn?  Does anyone know where?
>> 
>> thanks
>> david jencks
>> 
>>> On Aug 4, 2020, at 9:51 PM, Romain Manni-Bucau <rmannibucau@gmail.com>
>> wrote:
>>> 
>>> Buildbot uses bash so just ensure node is there - a bit like travis does
>> -
>>> and if not download it and that's it.
>>> 
>>> Alternatively frontend plugin works well as mzntionned by David:
>>> 
>> https://github.com/Talend/component-runtime/blob/master/documentation/pom.xml#L567
>>> 
>>> 
>>> Le mar. 4 août 2020 à 21:27, David Jencks <david.a.jencks@gmail.com>
a
>>> écrit :
>>> 
>>>> In typical apache fashion, there doesn’t appear to be any actual
>>>> information about how to use buildbot or what it can  do. However,
>> buildbot
>>>> claims to be a general purpose tool.  It’s possible to run Antora from
>>>> maven, so if we can’t figure out any more direct approach we can do
>> that.
>>>> Building on GitHub using GitHub actions might be another option: that’s
>>>> definitely possible.
>>>> 
>>>> David Jencks
>>>> 
>>>>> On Aug 4, 2020, at 12:00 PM, Raymond Auge <raymond.auge@liferay.com
>> .INVALID>
>>>> wrote:
>>>>> 
>>>>> It looks like antora requires node.js to build? Can such a thing run
on
>>>> the
>>>>> ASF buildbot jobs?
>>>>> 
>>>>> - Ray
>>>>> 
>>>>> On Tue, Aug 4, 2020 at 12:46 PM Romain Manni-Bucau <
>>>> rmannibucau@gmail.com>
>>>>> wrote:
>>>>> 
>>>>>> +1, also enables to trivially generate doc parts/partials which is
>> super
>>>>>> important for all the configuration IMHO.
>>>>>> 
>>>>>> Romain Manni-Bucau
>>>>>> @rmannibucau <https://twitter.com/rmannibucau> |  Blog
>>>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>>>> <http://rmannibucau.wordpress.com> | Github <
>>>>>> https://github.com/rmannibucau> |
>>>>>> LinkedIn <https://www.linkedin.com/in/rmannibucau> | Book
>>>>>> <
>>>>>> 
>>>> 
>> https://www.packtpub.com/application-development/java-ee-8-high-performance
>>>>>>> 
>>>>>> 
>>>>>> 
>>>>>> Le mar. 4 août 2020 à 18:36, Raymond Auge <raymond.auge@liferay.com
>>>>>> .invalid>
>>>>>> a écrit :
>>>>>> 
>>>>>>> I would make a case to integrate the site content into the same
>>>>>> repository
>>>>>>> that contains the code.
>>>>>>> 
>>>>>>> Why? This makes it much more apt to being kept up to date since
>> changes
>>>>>> can
>>>>>>> be made to both sources, docs and site content in a single changeset.
>>>>>>> 
>>>>>>> Thoughts?
>>>>>>> 
>>>>>>> - Ray
>>>>>>> 
>>>>>>> On Tue, Aug 4, 2020 at 12:31 PM Raymond Auge <
>> raymond.auge@liferay.com
>>>>> 
>>>>>>> wrote:
>>>>>>> 
>>>>>>>> For reference here is the INFRA ticket [1] for this migration
task.
>>>>>>>> 
>>>>>>>> - Ray
>>>>>>>> 
>>>>>>>> [1] https://issues.apache.org/jira/browse/INFRA-20633
>>>>>>>> 
>>>>>>>> On Tue, Aug 4, 2020 at 12:19 PM Raymond Auge <
>>>> raymond.auge@liferay.com
>>>>>>> 
>>>>>>>> wrote:
>>>>>>>> 
>>>>>>>>> David, That would be great!
>>>>>>>>> 
>>>>>>>>> Let's see where consensus takes us.
>>>>>>>>> 
>>>>>>>>> So far we have antora as a candidate. Does anyone else
have a
>> strong
>>>>>>>>> desire to take some other solution?
>>>>>>>>> 
>>>>>>>>> - Ray
>>>>>>>>> 
>>>>>>>>> On Tue, Aug 4, 2020 at 12:09 PM David Jencks <
>>>>>> david.a.jencks@gmail.com>
>>>>>>>>> wrote:
>>>>>>>>> 
>>>>>>>>>> The Camel website is mostly built with Antora (I
don’t understand
>>>>>> their
>>>>>>>>>> reluctance to use it for everything). https://camel.apache.org/
<
>>>>>>>>>> https://camel.apache.org/>
>>>>>>>>>> 
>>>>>>>>>> I might be able to help with a migration to Antora.
>>>>>>>>>> 
>>>>>>>>>> David Jencks
>>>>>>>>>> 
>>>>>>>>>>> On Aug 4, 2020, at 8:45 AM, Romain Manni-Bucau
<
>>>>>>> rmannibucau@gmail.com>
>>>>>>>>>> wrote:
>>>>>>>>>>> 
>>>>>>>>>>> https://docs.antora.org/antora/2.3/
>>>>>>>>>>> 
>>>>>>>>>>> Long story short you write the doc in asciidoctor
(which also
>> means
>>>>>>>>>> you can
>>>>>>>>>>> bulk import html in the transition period or
markdown since
>>>>>>> asciidoctor
>>>>>>>>>>> supports most of markdown), then you create a
descriptor file
>> list
>>>>>>> the
>>>>>>>>>>> source repos you want, then it will render all
the sites
>> properly.
>>>>>>>>>>> All that generates a static website you just
upload with
>> svnpubsub
>>>>>>> (or
>>>>>>>>>> git
>>>>>>>>>>> flavor) or any solution you want.
>>>>>>>>>>> The product website uses that and I used it for
>>>>>>>>>>> https://talend.github.io/component-runtime/
>>>>>>>>>>> <
>> https://talend.github.io/component-runtime/main/1.1.24/index.html
>>>>>>> 
>>>>>>>>>> too.
>>>>>>>>>>> 
>>>>>>>>>>> Romain Manni-Bucau
>>>>>>>>>>> @rmannibucau <https://twitter.com/rmannibucau>
|  Blog
>>>>>>>>>>> <https://rmannibucau.metawerx.net/> | Old
Blog
>>>>>>>>>>> <http://rmannibucau.wordpress.com> | Github
<
>>>>>>>>>> https://github.com/rmannibucau> |
>>>>>>>>>>> LinkedIn <https://www.linkedin.com/in/rmannibucau>
| Book
>>>>>>>>>>> <
>>>>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>> https://www.packtpub.com/application-development/java-ee-8-high-performance
>>>>>>>>>>> 
>>>>>>>>>>> 
>>>>>>>>>>> 
>>>>>>>>>>> Le mar. 4 août 2020 à 17:42, Raymond Auge <
>>>>>> raymond.auge@liferay.com
>>>>>>>>>> .invalid>
>>>>>>>>>>> a écrit :
>>>>>>>>>>> 
>>>>>>>>>>>> On Tue, Aug 4, 2020 at 11:39 AM Romain Manni-Bucau
<
>>>>>>>>>> rmannibucau@gmail.com>
>>>>>>>>>>>> wrote:
>>>>>>>>>>>> 
>>>>>>>>>>>>> Hi Ray,
>>>>>>>>>>>>> 
>>>>>>>>>>>>> Did you have a look to antora?
>>>>>>>>>>>>> It is exactly designed for this kind
of thing and works quite
>>>>>> well.
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> I have not. Link? :)
>>>>>>>>>>>> 
>>>>>>>>>>>> (it is not on the Apache wiki page referenced,
so if it makes
>> for
>>>>>> a
>>>>>>>>>> good
>>>>>>>>>>>> story and integrates well into the Apache
infra maybe we can
>>>>>>> document
>>>>>>>>>> it
>>>>>>>>>>>> there as well)
>>>>>>>>>>>> 
>>>>>>>>>>>> - Ray
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>>> Romain Manni-Bucau
>>>>>>>>>>>>> @rmannibucau <https://twitter.com/rmannibucau>
|  Blog
>>>>>>>>>>>>> <https://rmannibucau.metawerx.net/>
| Old Blog
>>>>>>>>>>>>> <http://rmannibucau.wordpress.com>
| Github <
>>>>>>>>>>>>> https://github.com/rmannibucau> |
>>>>>>>>>>>>> LinkedIn <https://www.linkedin.com/in/rmannibucau>
| Book
>>>>>>>>>>>>> <
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>> https://www.packtpub.com/application-development/java-ee-8-high-performance
>>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>>> Le mar. 4 août 2020 à 17:30, Raymond
Auge <
>>>>>>> raymond.auge@liferay.com
>>>>>>>>>>>>> .invalid>
>>>>>>>>>>>>> a écrit :
>>>>>>>>>>>>> 
>>>>>>>>>>>>>> ugh... forgot to CC you andrew. Please
read back.
>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> On Tue, Aug 4, 2020 at 11:29 AM Raymond
Auge <
>>>>>>>>>> raymond.auge@liferay.com
>>>>>>>>>>>>> 
>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> Hey Andrew,
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> Aries is structured as several
repos where the main repo
>>>>>> contains
>>>>>>>>>>>>> several
>>>>>>>>>>>>>>> sub-projects, but several other
sub-projects are broken out
>>>>>> into
>>>>>>>>>>>> their
>>>>>>>>>>>>>> own
>>>>>>>>>>>>>>> repos. All repos are git.
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> What options do you recommend
for this scenario?
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> It would be great if the main
repo could hold the core site
>> and
>>>>>>>>>> then
>>>>>>>>>>>>>>> separate repos contribute their
content somehow.
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> Any ideas how we could do that
(sequenced build triggers and
>>>>>>>>>>>> scheduled
>>>>>>>>>>>>>>> jobs is what I'm thinking)?
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> - Ray
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> On Tue, Aug 4, 2020 at 10:42
AM Raymond Auge <
>>>>>>>>>>>> raymond.auge@liferay.com
>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> On Tue, Aug 4, 2020 at 10:40
AM Raymond Auge <
>>>>>>>>>>>>> raymond.auge@liferay.com>
>>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> Hi Andrew,
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> The site is indeed still
using the old CMS and it would be
>>>>>>> great
>>>>>>>>>> to
>>>>>>>>>>>>>>>>> transition it. I can
try to do this.
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> I'll look through the
info you've sent but if there's a
>>>>>>> specific
>>>>>>>>>>>>> guide
>>>>>>>>>>>>>>>>> or checklist that helps
migrate to any particular solution
>>>>>> that
>>>>>>>>>>>> would
>>>>>>>>>>>>>> be
>>>>>>>>>>>>>>>>> helpful.
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> Sincerely,
>>>>>>>>>>>>>>>>> - Ray
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> On Tue, Aug 4, 2020 at
9:33 AM Andrew Wetmore <
>>>>>>>>>> andreww@apache.org>
>>>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> Infra is assembling
a Wiki page [2]
>>>>>>>>>>>>>>>>>> on migrating a website
from the CMS, and is looking
>> forward
>>>>>> to
>>>>>>>>>>>>> helping
>>>>>>>>>>>>>>>>>> projects with this
transition.
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> .. Wiki, got it! I will start
with that. I may have many
>>>>>>> questions
>>>>>>>>>>>> for
>>>>>>>>>>>>>>>> you along the way. ;)
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> - Ray
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> Please let me know
whether your site is still on the
>> Apache
>>>>>>> CMS
>>>>>>>>>>>> and,
>>>>>>>>>>>>>> if
>>>>>>>>>>>>>>>>>> so,
>>>>>>>>>>>>>>>>>> who will be the project
point-of-contact with Infra for
>> the
>>>>>>>>>>>>> migration.
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> Thank you!
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> [1] https://infra.apache.org/project-site.html
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> [2]
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>> https://cwiki.apache.org/confluence/display/INFRA/Migrate+your+project+website+from+the+Apache+CMS
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>>> Andrew Wetmore
>>>>>>>>>>>>>>>>>> Technical Writer-Editor
>>>>>>>>>>>>>>>>>> Infra
>>>>>>>>>>>>>>>>>> *Apache Software
Foundation*
>>>>>>>>>>>>>>>>>> andreww@apache.org
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> <
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
>>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> Virus-free.
>>>>>>>>>>>>>>>>>> www.avast.com
>>>>>>>>>>>>>>>>>> <
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>> https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail
>>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>>> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
>>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>> *Raymond Augé* <
>>>>>>> http://www.liferay.com/web/raymond.auge/profile>
>>>>>>>>>>>>>>>>> (@rotty3000)
>>>>>>>>>>>>>>>>> Senior Software Architect
*Liferay, Inc.* <
>>>>>>>>>> http://www.liferay.com>
>>>>>>>>>>>>>>>>> (@Liferay)
>>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>> *Raymond Augé* <
>>>>>> http://www.liferay.com/web/raymond.auge/profile
>>>>>>>> 
>>>>>>>>>>>>>>>> (@rotty3000)
>>>>>>>>>>>>>>>> Senior Software Architect
*Liferay, Inc.* <
>>>>>>> http://www.liferay.com
>>>>>>>>>>> 
>>>>>>>>>>>>>>>> (@Liferay)
>>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>> *Raymond Augé* <
>>>>>> http://www.liferay.com/web/raymond.auge/profile>
>>>>>>>>>>>>>>> (@rotty3000)
>>>>>>>>>>>>>>> Senior Software Architect *Liferay,
Inc.* <
>>>>>>> http://www.liferay.com>
>>>>>>>>>>>>>>> (@Liferay)
>>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> 
>>>>>>>>>>>>>> --
>>>>>>>>>>>>>> *Raymond Augé* <
>> http://www.liferay.com/web/raymond.auge/profile
>>>>>>> 
>>>>>>>>>>>>>> (@rotty3000)
>>>>>>>>>>>>>> Senior Software Architect *Liferay,
Inc.* <
>>>>>> http://www.liferay.com
>>>>>>>> 
>>>>>>>>>>>>>> (@Liferay)
>>>>>>>>>>>>>> 
>>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> --
>>>>>>>>>>>> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile
>>> 
>>>>>>>>>>>> (@rotty3000)
>>>>>>>>>>>> Senior Software Architect *Liferay, Inc.*
<
>> http://www.liferay.com
>>>>>>> 
>>>>>>>>>>>> (@Liferay)
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>> 
>>>>>>>>> --
>>>>>>>>> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile>
>>>>>>>>> (@rotty3000)
>>>>>>>>> Senior Software Architect *Liferay, Inc.* <http://www.liferay.com>
>>>>>>>>> (@Liferay)
>>>>>>>>> 
>>>>>>>> 
>>>>>>>> 
>>>>>>>> --
>>>>>>>> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile>
>>>>>>>> (@rotty3000)
>>>>>>>> Senior Software Architect *Liferay, Inc.* <http://www.liferay.com>
>>>>>>>> (@Liferay)
>>>>>>>> 
>>>>>>> 
>>>>>>> 
>>>>>>> --
>>>>>>> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile>
>>>>>>> (@rotty3000)
>>>>>>> Senior Software Architect *Liferay, Inc.* <http://www.liferay.com>
>>>>>>> (@Liferay)
>>>>>>> 
>>>>>> 
>>>>> 
>>>>> 
>>>>> --
>>>>> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile>
>>>>> (@rotty3000)
>>>>> Senior Software Architect *Liferay, Inc.* <http://www.liferay.com>
>>>>> (@Liferay)
>>>> 
>>>> 
>> 
>> 
> 
> -- 
> *Raymond Augé* <http://www.liferay.com/web/raymond.auge/profile>
> (@rotty3000)
> Senior Software Architect *Liferay, Inc.* <http://www.liferay.com>
> (@Liferay)


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message