There is not much in the pull request. I am assuming we will want to have more than how to contribute and a pointer to code. Perhaps sections on how to setup / use and examples, more user oriented, documentation. Does this proposal account for that while keeping in mind that most developers won't want to write such? This means that the solution has to adapt to non-developer documentation specialist types. And to be honest, I have no idea what tools they want to use. But if we want blogs and similar components of the site I think this is where those would go. Am I correct? If so, how are they going to be handled?
On Mon, Mar 20, 2023 at 2:20 PM PJ Fanning <[email protected]> wrote: > This is basically > https://github.com/apache/incubator-pekko-site/pull/4 - a few pages > needed to tie the existing pages that we can generate for the project > docs together. > > * A home page - a bit like https://spark.apache.org/ > * possibly a separate page linking to the the various module docs - > something a bit like https://akka.io/docs/ > * a download page (for the source releases and probably to provide > some sample sbt and maven scripting for getting jars from Maven > Central) - something like > https://logging.apache.org/log4j/2.x/download.html > > I would strongly favour continuing with > https://github.com/apache/incubator-pekko-site/pull/4. Many of us are > used to Paradox. We get the same look and feel as the rest of our > pre-existing Paradox generated docs - like the ones visible at > https://pekko.apache.org at the moment. > > On Mon, 20 Mar 2023 at 14:58, Claude Warren, Jr > <[email protected]> wrote: > > > > Is this the website at pekko.apache.org or are you talking about the > java > > doc and equivalent? > > > > Do we have anybody who has expertise in documentation development? > > > > On Wed, Mar 1, 2023 at 12:08 PM Matthew Benedict de Detrich > > <[email protected]> wrote: > > > > > Previous discussion/s on this > > > > > > https://github.com/apache/incubator-pekko-site/pull/4 > > > https://lists.apache.org/thread/lzfkmq6k6y9t02y4o97jmcgnzxqcp4kh > > > > > > I think this would be a good time to discuss what software we should > use to > > > generate our microsite at https://pekko.apache.org/ > > > > > > Suggestions that have already been made > > > > > > * Paradox: https://github.com/lightbend/paradox (we use this > currently for > > > docs and there is a current setup for it, see previously mentioned PR) > > > * sbt-microsites: https://github.com/47degrees/sbt-microsites (uses > Jekyll > > > under the hood but wraps it in sbt which is the same build tool that is > > > used for all of the other Pekko projects) > > > * https://github.com/planet42/Laika: Completely new design for > microsites, > > > used somewhat in Scala projects. Also works with sbt > > > * https://infra.apache.org/asf-pelican.html Used by Apache projects > > > > > > I am personally leaning towards either Paradox or sbt-microsites. My > > > personal view on this is that while there are other technologies like > > > pelican which have historically been used with Apache, to me keeping > the > > > number of tech stacks/build tools in the Pekko ecosystem has higher > > > priority and both of these projects use the exact same build tool that > > > Pekko libraries do. > > > > > > Ontop of this sbt-paradox is currently being used to generate our docs > for > > > our various modules, although it does appear to be more catered for doc > > > generated than microsites (I don't know how significant the difference > is > > > between the two). > > > -- > > > > > > Matthew de Detrich > > > > > > *Aiven Deutschland GmbH* > > > > > > Immanuelkirchstraße 26, 10405 Berlin > > > > > > Amtsgericht Charlottenburg, HRB 209739 B > > > > > > Geschäftsführer: Oskari Saarenmaa & Hannu Valtonen > > > > > > *m:* +491603708037 > > > > > > *w:* aiven.io *e:* [email protected] > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > >
