You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by Oscar Westra van Holthe - Kind <os...@westravanholthe.nl> on 2021/11/02 16:08:08 UTC
Re: New website
Hi,
This is a huge improvement. Responsive, excellent navigation, syntax
highlighting, ...
The only downside I see was already mentioned by Lee: the landing page is
too empty (also in a mobile browser).
I think we could really benefit from mentioning the unique selling point of
Avro here: "Your Data. Any Time, Anywhere." And then mention the language
availability & excellent schema evolution.
Kind regards,
Oscar
On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org> wrote:
> Hi all,
>
> Please check the new candidate for Apache Avro website:
> https://avro-website.netlify.app/
>
> It is based on Hugo and uses Docsy theme.
> Its source code and instructions how to build could be found at
> https://github.com/martin-g/avro-website.
> The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>
> I am not web designer, so some things may look not finished.
> I've just copied the HTML content from the old site (
> https://avro.apache.org/) and converted it to Markdown for Hugo.
>
> Any feedback is welcome! With Pull Requests would be awesome!
>
> Regards,
> Martin
>
Re: New website
Posted by Ryan Skraba <ry...@skraba.com>.
Just a quick update -- we merged the current state of the website into
master today! Thanks so much to Martin and Oscar who have been taking
care of this on the separate repo!
I moved all the existing docs temporarily to doc-deprecated (it's
easier to have this old material available while we're stabilizing),
and there's probably going to be a number of changes before publishing
-- but don't hesitate to discuss, raise JIRA, make PRs now!
You won't see the website in action until the next release, but
hopefully we can get that going soon. I've spent quite a few hours on
it to figure out the "release process", which will probably involve
some manual steps at first. Notably it's missing the documentation to
build and review the website locally! I'll prioritize getting that in
place.
Github Actions should still be working for all of the SDKs, but you
might find some problems building the documentation locally for a bit.
Thanks everyone, I think we're all looking forward to seeing this in place!
Ryan
On Mon, Jan 31, 2022 at 10:55 AM Martin Grigorov <mg...@apache.org> wrote:
>
> Hi,
>
> I've just updated https://avro-website.netlify.app
>
> 1. https://avro-website.netlify.app/blog/news/ - added the only News from
> https://avro.apache.org/releases.html
> 2. https://avro-website.netlify.app/blog/releases/ - has all release
> announcements from https://avro.apache.org/releases.html
> 3. Updated the "Documentation" menu in the top panel:
> 3.1. to have an entry for "next" (this is the docs for current master)
> 3.2. All other menu items are links to the documentation for the old
> versions at https://svn.apache.org/repos/asf/avro/site/publish/docs/ X.Y.Z
> 4. I've left the offline search functionality for now. An index file is
> around 130K. I am not sure now whether it causes the slowness in the git
> operations.
>
> Please review the latest state of the website and let me know what you
> think!
>
> Regards,
> Martin
>
> On Tue, Jan 25, 2022 at 11:08 PM Martin Grigorov <mg...@apache.org>
> wrote:
>
> > Hey Ryan!
> >
> > On Tue, Jan 25, 2022, 19:28 Ryan Skraba <ry...@skraba.com> wrote:
> >
> >> Hey there! I'm motivated to see this happen too :D
> >>
> >> I suggest that we use AVRO-2175 to track anything we'd like to see
> >> before switching and AVRO-3264 to collect improvements that can wait
> >> until afterwards. I'm convinced that refreshing the site will
> >> encourage others to improve it.
> >>
> >
> > I don't have access to my ASF account at the moment, so I won't be able to
> > update the tickets this week.
> >
> >
> >> Here are the things that I'd like to see before the switch, almost all
> >> related to deciding where and how to put things:
> >>
> >> 1) Ensure that we don't break existing links during the migration.
> >>
> >> For example https://avro.apache.org/releases.html versus
> >> https://avro-website.netlify.app/project/download/
> >
> >
> >
> > The new website has a special page for news:
> > https://avro-website.netlify.app/blog/news/
> > I'll add all entries from the old releases.html!
> >
> >
> >>
> >> 2) Decide how we are going to deal with existing web resources.
> >>
> >> The existing resources under https://avro.apache.org/docs/ are
> >> more-or-less like artifacts from the release, generated from the
> >> release source code. I don't think we should be modifying or removing
> >> them.
> >>
> >> The new specification in markdown format should be published for the
> >> next release 1.11.1 or 1.12.0. There's a bit of discussion at [PR#4]
> >> and [PR#6] with dealing with "old" resources -- it's not sustainable
> >> to include them as Hugo static resources
> >
> >
> > OK!
> > I can easily reuse the current/1.11.0 docs for the upcoming 1.11.1 and/or
> > 1.12.0!
> > The links for the previous versions will point to SVN.
> >
> >
> >
> >> 3) Decide where and how to host what we've built.
> >>
> >> Currently, updating the website only happens on a release (there's no
> >> way to see SNAPSHOT documentation), and by manually updating the
> >> contents at https://svn.apache.org/repos/asf/avro/site/publish/
> >>
> >> I do like what flink is doing with https://nightlies.apache.org/flink/
> >> (with different versions built and hosted per-minor release and for
> >> master). Would this be the right way to go? How would this work with
> >> the existing structure in svn, or in an asf-site branch or repository?
> >
> >
> >> I'm OK with requiring manual intervention at first, but it would be
> >> great if the nightlies were automated quickly.
> >>
> >
> >
> > A GitHub Action workflow can do all this!
> > But we'll have to have branch-1.11.1 instead of just branch-1.11.
> >
> >
> >> All my best and thanks for pushing this forward!
> >>
> >
> > One more thing: the new site has client-side search functionality. I like
> > it a lot but it adds a lot of pressure on Git. It uses a unique name for a
> > rather big JSON file, i.e. after any update one needs to remove the
> > previous JSON file from Git and add the new one. And this also touches all
> > other generated HTML files, because they include it.
> > I suggest to disable the search functionality!
> >
> >
> >
> >> Ryan
> >>
> >>
> >> [PR#4]: https://github.com/martin-g/avro-website/pull/4
> >> [PR#6]: https://github.com/martin-g/avro-website/pull/64
> >> [AVRO-2175]: https://issues.apache.org/jira/browse/AVRO-2175
> >> [AVRO-3264]: https://issues.apache.org/jira/browse/AVRO-3264
> >>
> >> On Tue, Jan 25, 2022 at 9:31 AM Oscar Westra van Holthe - Kind
> >> <os...@westravanholthe.nl> wrote:
> >> >
> >> > Hi all,
> >> >
> >> > +1 from me for moving to the new website
> >> >
> >> > You've done a great job!
> >> >
> >> >
> >> > --
> >> > Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>
> >> >
> >> > Op di 25 jan. 2022 08:36 schreef Martin Grigorov <mgrigorov@apache.org
> >> >:
> >> >
> >> > > Hi,
> >> > >
> >> > > Shall we replace the old website with the new one ?
> >> > >
> >> > > I will have time to work on it next week, so if we decide what to do
> >> then I
> >> > > could do it all by myself with my new superpowers (committership!)
> >> > >
> >> > > Martin
> >> > >
> >> > > On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mgrigorov@apache.org
> >> >
> >> > > wrote:
> >> > >
> >> > > >
> >> > > >
> >> > > > On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <
> >> mgrigorov@apache.org>
> >> > > > wrote:
> >> > > >
> >> > > >> Hi Ryan,
> >> > > >>
> >> > > >> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com>
> >> wrote:
> >> > > >>
> >> > > >>> Hello!
> >> > > >>>
> >> > > >>> I realized that I haven't commented on this mailing list thread
> >> -- I
> >> > > >>> made some comments on
> >> https://issues.apache.org/jira/browse/AVRO-2175
> >> > > >>>
> >> > > >>> This looks amazing and we should merge it very soon :D It's not
> >> > > >>> perfect, but it's really a great improvement and definitely not
> >> worst
> >> > > >>> than the existing website!
> >> > > >>>
> >> > > >>> I've been taking a look at what we need to use the existing
> >> > > >>> infrastructure, and there's interesting links at:
> >> > > >>>
> >> > > >>> - https://infra.apache.org/release-download-pages.html
> >> > > >>> -
> >> > > >>>
> >> > >
> >> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> >> > > >>> - https://infra.apache.org/website-guidelines.html
> >> > > >>> - https://infra.apache.org/project-site.html
> >> > > >>>
> >> > > >>> I like that Beam has the website in the main repo, but notably the
> >> > > >>> INFRA recommendation is that we use a separate repo for the
> >> website
> >> > > >>> (named `avro-site` though). Any thoughts? It's always something
> >> we
> >> > > >>> can try and change later! Would it make it easier for the
> >> javadoc and
> >> > > >>> other languages if they were in the same repo, or does it make
> >> little
> >> > > >>> difference?
> >> > > >>>
> >> > > >>
> >> > > >> Since some docs are generated by other tools (C/C++/C#) and they
> >> need to
> >> > > >> be copied to the rest of the website I agree that it would be
> >> easier if
> >> > > the
> >> > > >> website is in the main repo!
> >> > > >> Also any changes to the spec/IDL will be in one PR (same repo)
> >> instead
> >> > > of
> >> > > >> two (main+website).
> >> > > >>
> >> > > >>
> >> > > >>>
> >> > > >>> The old site actually contains all of the documentation for EVERY
> >> > > >>> release, which can be found here:
> >> > > >>>
> >> > > >>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> >> > > >>> - https://avro.apache.org/docs/
> >> > > >>>
> >> > > >>> Would it be tricky to adjust your work to mirror the existing
> >> > > >>> structure for existing docs? I'm not even too fussy about not
> >> > > >>> breaking the links in /docs/current/ but all of the existing pages
> >> > > >>> such as /docs/1.7.7/ should be maintained if possible!
> >> > > >>>
> >> > > >>
> >> > > >> I could make the "Documention" nav tab into a dropdown with menu
> >> items,
> >> > > >> one for each version.
> >> > > >> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> >> > > >> documents. The menu items for all previous versions will be links
> >> to the
> >> > > >> respective folder at https://avro.apache.org/docs/.
> >> > > >>
> >> > > >
> >> > > > Done!
> >> > > > https://avro-website.netlify.app/
> >> > > >
> >> > > >
> >> > > >> If someone wants to migrate some more old docs to Markdown then
> >> please
> >> > > >> fork the repo and send a PR!
> >> > > >>
> >> > > >>
> >> > > >>>
> >> > > >>> There's so many good suggestions here for future work and
> >> improving
> >> > > >>> our message and communication, I created
> >> > > >>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> >> > > >>> discussion after we get this up.
> >> > > >>>
> >> > > >>> Thanks again for your great work!
> >> > > >>>
> >> > > >>> Ryan
> >> > > >>>
> >> > > >>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <lee.hambley@gmail.com
> >> >
> >> > > >>> wrote:
> >> > > >>> >
> >> > > >>> > I speak only for myself, but I am working in an environment
> >> where I
> >> > > am
> >> > > >>> regularly checking docs all the way back to 1.8.x because we have
> >> > > legacy
> >> > > >>> systems we cannot upgrade, and I am often referencing rules about
> >> > > schema
> >> > > >>> canonical form. I value a lot the sidebar bottom version switching
> >> > > >>> navigation from sites such as here
> >> > > >>>
> >> > >
> >> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> >> > > >>> ... but I know it can be extraordinarily difficult to make it work
> >> > > >>> correctly with these static site generators.
> >> > > >>> >
> >> > > >>> > Lee Hambley
> >> > > >>> > http://lee.hambley.name/
> >> > > >>> > +49 (0) 170 298 5667
> >> > > >>> >
> >> > > >>> >
> >> > > >>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <
> >> mgrigorov@apache.org>
> >> > > >>> wrote:
> >> > > >>> >>
> >> > > >>> >>
> >> > > >>> >>
> >> > > >>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <iemejia@gmail.com
> >> >
> >> > > >>> wrote:
> >> > > >>> >>>
> >> > > >>> >>> Wow this is pretty neat ! Nice job Martin! A modern website
> >> can
> >> > > >>> >>> encourage more contributions.
> >> > > >>> >>> I am more interested on content than aesthetics first. Is
> >> > > everything
> >> > > >>> >>> already migrated? Anything missing? Any issue to report?
> >> > > >>> >>
> >> > > >>> >>
> >> > > >>> >> Everything is migrated for the documentation of the *current*
> >> > > version.
> >> > > >>> >> The old site contains documentation for both current and
> >> current-1.
> >> > > >>> Is this something you would like to preserve ?
> >> > > >>> >>
> >> > > >>> >>>
> >> > > >>> >>>
> >> > > >>> >>>
> >> > > >>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <
> >> > > mgrigorov@apache.org>
> >> > > >>> wrote:
> >> > > >>> >>> >
> >> > > >>> >>> > Hi,
> >> > > >>> >>> >
> >> > > >>> >>> > Anyone willing to send a PR with the suggested improvement?
> >> > > >>> >>> > Or at least open an issue with the well formulated text and
> >> I
> >> > > will
> >> > > >>> add it!
> >> > > >>> >>> >
> >> > > >>> >>> > Regards,
> >> > > >>> >>> > Martin
> >> > > >>> >>> >
> >> > > >>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> >> > > >>> oscar@westravanholthe.nl> wrote:
> >> > > >>> >>> >>
> >> > > >>> >>> >> Hi,
> >> > > >>> >>> >>
> >> > > >>> >>> >> This is a huge improvement. Responsive, excellent
> >> navigation,
> >> > > >>> syntax
> >> > > >>> >>> >> highlighting, ...
> >> > > >>> >>> >>
> >> > > >>> >>> >> The only downside I see was already mentioned by Lee: the
> >> > > landing
> >> > > >>> page is
> >> > > >>> >>> >> too empty (also in a mobile browser).
> >> > > >>> >>> >> I think we could really benefit from mentioning the unique
> >> > > >>> selling point of
> >> > > >>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then
> >> mention the
> >> > > >>> language
> >> > > >>> >>> >> availability & excellent schema evolution.
> >> > > >>> >>> >>
> >> > > >>> >>> >> Kind regards,
> >> > > >>> >>> >> Oscar
> >> > > >>> >>> >>
> >> > > >>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
> >> > > >>> mgrigorov@apache.org> wrote:
> >> > > >>> >>> >>
> >> > > >>> >>> >> > Hi all,
> >> > > >>> >>> >> >
> >> > > >>> >>> >> > Please check the new candidate for Apache Avro website:
> >> > > >>> >>> >> > https://avro-website.netlify.app/
> >> > > >>> >>> >> >
> >> > > >>> >>> >> > It is based on Hugo and uses Docsy theme.
> >> > > >>> >>> >> > Its source code and instructions how to build could be
> >> found
> >> > > at
> >> > > >>> >>> >> > https://github.com/martin-g/avro-website.
> >> > > >>> >>> >> > The JIRA ticket is:
> >> > > >>> https://issues.apache.org/jira/browse/AVRO-2175
> >> > > >>> >>> >> >
> >> > > >>> >>> >> > I am not web designer, so some things may look not
> >> finished.
> >> > > >>> >>> >> > I've just copied the HTML content from the old site (
> >> > > >>> >>> >> > https://avro.apache.org/) and converted it to Markdown
> >> for
> >> > > >>> Hugo.
> >> > > >>> >>> >> >
> >> > > >>> >>> >> > Any feedback is welcome! With Pull Requests would be
> >> awesome!
> >> > > >>> >>> >> >
> >> > > >>> >>> >> > Regards,
> >> > > >>> >>> >> > Martin
> >> > > >>> >>> >> >
> >> > > >>>
> >> > > >>
> >> > >
> >>
> >
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi,
I've just updated https://avro-website.netlify.app
1. https://avro-website.netlify.app/blog/news/ - added the only News from
https://avro.apache.org/releases.html
2. https://avro-website.netlify.app/blog/releases/ - has all release
announcements from https://avro.apache.org/releases.html
3. Updated the "Documentation" menu in the top panel:
3.1. to have an entry for "next" (this is the docs for current master)
3.2. All other menu items are links to the documentation for the old
versions at https://svn.apache.org/repos/asf/avro/site/publish/docs/ X.Y.Z
4. I've left the offline search functionality for now. An index file is
around 130K. I am not sure now whether it causes the slowness in the git
operations.
Please review the latest state of the website and let me know what you
think!
Regards,
Martin
On Tue, Jan 25, 2022 at 11:08 PM Martin Grigorov <mg...@apache.org>
wrote:
> Hey Ryan!
>
> On Tue, Jan 25, 2022, 19:28 Ryan Skraba <ry...@skraba.com> wrote:
>
>> Hey there! I'm motivated to see this happen too :D
>>
>> I suggest that we use AVRO-2175 to track anything we'd like to see
>> before switching and AVRO-3264 to collect improvements that can wait
>> until afterwards. I'm convinced that refreshing the site will
>> encourage others to improve it.
>>
>
> I don't have access to my ASF account at the moment, so I won't be able to
> update the tickets this week.
>
>
>> Here are the things that I'd like to see before the switch, almost all
>> related to deciding where and how to put things:
>>
>> 1) Ensure that we don't break existing links during the migration.
>>
>> For example https://avro.apache.org/releases.html versus
>> https://avro-website.netlify.app/project/download/
>
>
>
> The new website has a special page for news:
> https://avro-website.netlify.app/blog/news/
> I'll add all entries from the old releases.html!
>
>
>>
>> 2) Decide how we are going to deal with existing web resources.
>>
>> The existing resources under https://avro.apache.org/docs/ are
>> more-or-less like artifacts from the release, generated from the
>> release source code. I don't think we should be modifying or removing
>> them.
>>
>> The new specification in markdown format should be published for the
>> next release 1.11.1 or 1.12.0. There's a bit of discussion at [PR#4]
>> and [PR#6] with dealing with "old" resources -- it's not sustainable
>> to include them as Hugo static resources
>
>
> OK!
> I can easily reuse the current/1.11.0 docs for the upcoming 1.11.1 and/or
> 1.12.0!
> The links for the previous versions will point to SVN.
>
>
>
>> 3) Decide where and how to host what we've built.
>>
>> Currently, updating the website only happens on a release (there's no
>> way to see SNAPSHOT documentation), and by manually updating the
>> contents at https://svn.apache.org/repos/asf/avro/site/publish/
>>
>> I do like what flink is doing with https://nightlies.apache.org/flink/
>> (with different versions built and hosted per-minor release and for
>> master). Would this be the right way to go? How would this work with
>> the existing structure in svn, or in an asf-site branch or repository?
>
>
>> I'm OK with requiring manual intervention at first, but it would be
>> great if the nightlies were automated quickly.
>>
>
>
> A GitHub Action workflow can do all this!
> But we'll have to have branch-1.11.1 instead of just branch-1.11.
>
>
>> All my best and thanks for pushing this forward!
>>
>
> One more thing: the new site has client-side search functionality. I like
> it a lot but it adds a lot of pressure on Git. It uses a unique name for a
> rather big JSON file, i.e. after any update one needs to remove the
> previous JSON file from Git and add the new one. And this also touches all
> other generated HTML files, because they include it.
> I suggest to disable the search functionality!
>
>
>
>> Ryan
>>
>>
>> [PR#4]: https://github.com/martin-g/avro-website/pull/4
>> [PR#6]: https://github.com/martin-g/avro-website/pull/64
>> [AVRO-2175]: https://issues.apache.org/jira/browse/AVRO-2175
>> [AVRO-3264]: https://issues.apache.org/jira/browse/AVRO-3264
>>
>> On Tue, Jan 25, 2022 at 9:31 AM Oscar Westra van Holthe - Kind
>> <os...@westravanholthe.nl> wrote:
>> >
>> > Hi all,
>> >
>> > +1 from me for moving to the new website
>> >
>> > You've done a great job!
>> >
>> >
>> > --
>> > Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>
>> >
>> > Op di 25 jan. 2022 08:36 schreef Martin Grigorov <mgrigorov@apache.org
>> >:
>> >
>> > > Hi,
>> > >
>> > > Shall we replace the old website with the new one ?
>> > >
>> > > I will have time to work on it next week, so if we decide what to do
>> then I
>> > > could do it all by myself with my new superpowers (committership!)
>> > >
>> > > Martin
>> > >
>> > > On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mgrigorov@apache.org
>> >
>> > > wrote:
>> > >
>> > > >
>> > > >
>> > > > On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <
>> mgrigorov@apache.org>
>> > > > wrote:
>> > > >
>> > > >> Hi Ryan,
>> > > >>
>> > > >> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com>
>> wrote:
>> > > >>
>> > > >>> Hello!
>> > > >>>
>> > > >>> I realized that I haven't commented on this mailing list thread
>> -- I
>> > > >>> made some comments on
>> https://issues.apache.org/jira/browse/AVRO-2175
>> > > >>>
>> > > >>> This looks amazing and we should merge it very soon :D It's not
>> > > >>> perfect, but it's really a great improvement and definitely not
>> worst
>> > > >>> than the existing website!
>> > > >>>
>> > > >>> I've been taking a look at what we need to use the existing
>> > > >>> infrastructure, and there's interesting links at:
>> > > >>>
>> > > >>> - https://infra.apache.org/release-download-pages.html
>> > > >>> -
>> > > >>>
>> > >
>> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
>> > > >>> - https://infra.apache.org/website-guidelines.html
>> > > >>> - https://infra.apache.org/project-site.html
>> > > >>>
>> > > >>> I like that Beam has the website in the main repo, but notably the
>> > > >>> INFRA recommendation is that we use a separate repo for the
>> website
>> > > >>> (named `avro-site` though). Any thoughts? It's always something
>> we
>> > > >>> can try and change later! Would it make it easier for the
>> javadoc and
>> > > >>> other languages if they were in the same repo, or does it make
>> little
>> > > >>> difference?
>> > > >>>
>> > > >>
>> > > >> Since some docs are generated by other tools (C/C++/C#) and they
>> need to
>> > > >> be copied to the rest of the website I agree that it would be
>> easier if
>> > > the
>> > > >> website is in the main repo!
>> > > >> Also any changes to the spec/IDL will be in one PR (same repo)
>> instead
>> > > of
>> > > >> two (main+website).
>> > > >>
>> > > >>
>> > > >>>
>> > > >>> The old site actually contains all of the documentation for EVERY
>> > > >>> release, which can be found here:
>> > > >>>
>> > > >>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
>> > > >>> - https://avro.apache.org/docs/
>> > > >>>
>> > > >>> Would it be tricky to adjust your work to mirror the existing
>> > > >>> structure for existing docs? I'm not even too fussy about not
>> > > >>> breaking the links in /docs/current/ but all of the existing pages
>> > > >>> such as /docs/1.7.7/ should be maintained if possible!
>> > > >>>
>> > > >>
>> > > >> I could make the "Documention" nav tab into a dropdown with menu
>> items,
>> > > >> one for each version.
>> > > >> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
>> > > >> documents. The menu items for all previous versions will be links
>> to the
>> > > >> respective folder at https://avro.apache.org/docs/.
>> > > >>
>> > > >
>> > > > Done!
>> > > > https://avro-website.netlify.app/
>> > > >
>> > > >
>> > > >> If someone wants to migrate some more old docs to Markdown then
>> please
>> > > >> fork the repo and send a PR!
>> > > >>
>> > > >>
>> > > >>>
>> > > >>> There's so many good suggestions here for future work and
>> improving
>> > > >>> our message and communication, I created
>> > > >>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
>> > > >>> discussion after we get this up.
>> > > >>>
>> > > >>> Thanks again for your great work!
>> > > >>>
>> > > >>> Ryan
>> > > >>>
>> > > >>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <lee.hambley@gmail.com
>> >
>> > > >>> wrote:
>> > > >>> >
>> > > >>> > I speak only for myself, but I am working in an environment
>> where I
>> > > am
>> > > >>> regularly checking docs all the way back to 1.8.x because we have
>> > > legacy
>> > > >>> systems we cannot upgrade, and I am often referencing rules about
>> > > schema
>> > > >>> canonical form. I value a lot the sidebar bottom version switching
>> > > >>> navigation from sites such as here
>> > > >>>
>> > >
>> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
>> > > >>> ... but I know it can be extraordinarily difficult to make it work
>> > > >>> correctly with these static site generators.
>> > > >>> >
>> > > >>> > Lee Hambley
>> > > >>> > http://lee.hambley.name/
>> > > >>> > +49 (0) 170 298 5667
>> > > >>> >
>> > > >>> >
>> > > >>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <
>> mgrigorov@apache.org>
>> > > >>> wrote:
>> > > >>> >>
>> > > >>> >>
>> > > >>> >>
>> > > >>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <iemejia@gmail.com
>> >
>> > > >>> wrote:
>> > > >>> >>>
>> > > >>> >>> Wow this is pretty neat ! Nice job Martin! A modern website
>> can
>> > > >>> >>> encourage more contributions.
>> > > >>> >>> I am more interested on content than aesthetics first. Is
>> > > everything
>> > > >>> >>> already migrated? Anything missing? Any issue to report?
>> > > >>> >>
>> > > >>> >>
>> > > >>> >> Everything is migrated for the documentation of the *current*
>> > > version.
>> > > >>> >> The old site contains documentation for both current and
>> current-1.
>> > > >>> Is this something you would like to preserve ?
>> > > >>> >>
>> > > >>> >>>
>> > > >>> >>>
>> > > >>> >>>
>> > > >>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <
>> > > mgrigorov@apache.org>
>> > > >>> wrote:
>> > > >>> >>> >
>> > > >>> >>> > Hi,
>> > > >>> >>> >
>> > > >>> >>> > Anyone willing to send a PR with the suggested improvement?
>> > > >>> >>> > Or at least open an issue with the well formulated text and
>> I
>> > > will
>> > > >>> add it!
>> > > >>> >>> >
>> > > >>> >>> > Regards,
>> > > >>> >>> > Martin
>> > > >>> >>> >
>> > > >>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
>> > > >>> oscar@westravanholthe.nl> wrote:
>> > > >>> >>> >>
>> > > >>> >>> >> Hi,
>> > > >>> >>> >>
>> > > >>> >>> >> This is a huge improvement. Responsive, excellent
>> navigation,
>> > > >>> syntax
>> > > >>> >>> >> highlighting, ...
>> > > >>> >>> >>
>> > > >>> >>> >> The only downside I see was already mentioned by Lee: the
>> > > landing
>> > > >>> page is
>> > > >>> >>> >> too empty (also in a mobile browser).
>> > > >>> >>> >> I think we could really benefit from mentioning the unique
>> > > >>> selling point of
>> > > >>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then
>> mention the
>> > > >>> language
>> > > >>> >>> >> availability & excellent schema evolution.
>> > > >>> >>> >>
>> > > >>> >>> >> Kind regards,
>> > > >>> >>> >> Oscar
>> > > >>> >>> >>
>> > > >>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
>> > > >>> mgrigorov@apache.org> wrote:
>> > > >>> >>> >>
>> > > >>> >>> >> > Hi all,
>> > > >>> >>> >> >
>> > > >>> >>> >> > Please check the new candidate for Apache Avro website:
>> > > >>> >>> >> > https://avro-website.netlify.app/
>> > > >>> >>> >> >
>> > > >>> >>> >> > It is based on Hugo and uses Docsy theme.
>> > > >>> >>> >> > Its source code and instructions how to build could be
>> found
>> > > at
>> > > >>> >>> >> > https://github.com/martin-g/avro-website.
>> > > >>> >>> >> > The JIRA ticket is:
>> > > >>> https://issues.apache.org/jira/browse/AVRO-2175
>> > > >>> >>> >> >
>> > > >>> >>> >> > I am not web designer, so some things may look not
>> finished.
>> > > >>> >>> >> > I've just copied the HTML content from the old site (
>> > > >>> >>> >> > https://avro.apache.org/) and converted it to Markdown
>> for
>> > > >>> Hugo.
>> > > >>> >>> >> >
>> > > >>> >>> >> > Any feedback is welcome! With Pull Requests would be
>> awesome!
>> > > >>> >>> >> >
>> > > >>> >>> >> > Regards,
>> > > >>> >>> >> > Martin
>> > > >>> >>> >> >
>> > > >>>
>> > > >>
>> > >
>>
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hey Ryan!
On Tue, Jan 25, 2022, 19:28 Ryan Skraba <ry...@skraba.com> wrote:
> Hey there! I'm motivated to see this happen too :D
>
> I suggest that we use AVRO-2175 to track anything we'd like to see
> before switching and AVRO-3264 to collect improvements that can wait
> until afterwards. I'm convinced that refreshing the site will
> encourage others to improve it.
>
I don't have access to my ASF account at the moment, so I won't be able to
update the tickets this week.
> Here are the things that I'd like to see before the switch, almost all
> related to deciding where and how to put things:
>
> 1) Ensure that we don't break existing links during the migration.
>
> For example https://avro.apache.org/releases.html versus
> https://avro-website.netlify.app/project/download/
The new website has a special page for news:
https://avro-website.netlify.app/blog/news/
I'll add all entries from the old releases.html!
>
> 2) Decide how we are going to deal with existing web resources.
>
> The existing resources under https://avro.apache.org/docs/ are
> more-or-less like artifacts from the release, generated from the
> release source code. I don't think we should be modifying or removing
> them.
>
> The new specification in markdown format should be published for the
> next release 1.11.1 or 1.12.0. There's a bit of discussion at [PR#4]
> and [PR#6] with dealing with "old" resources -- it's not sustainable
> to include them as Hugo static resources
OK!
I can easily reuse the current/1.11.0 docs for the upcoming 1.11.1 and/or
1.12.0!
The links for the previous versions will point to SVN.
> 3) Decide where and how to host what we've built.
>
> Currently, updating the website only happens on a release (there's no
> way to see SNAPSHOT documentation), and by manually updating the
> contents at https://svn.apache.org/repos/asf/avro/site/publish/
>
> I do like what flink is doing with https://nightlies.apache.org/flink/
> (with different versions built and hosted per-minor release and for
> master). Would this be the right way to go? How would this work with
> the existing structure in svn, or in an asf-site branch or repository?
> I'm OK with requiring manual intervention at first, but it would be
> great if the nightlies were automated quickly.
>
A GitHub Action workflow can do all this!
But we'll have to have branch-1.11.1 instead of just branch-1.11.
> All my best and thanks for pushing this forward!
>
One more thing: the new site has client-side search functionality. I like
it a lot but it adds a lot of pressure on Git. It uses a unique name for a
rather big JSON file, i.e. after any update one needs to remove the
previous JSON file from Git and add the new one. And this also touches all
other generated HTML files, because they include it.
I suggest to disable the search functionality!
> Ryan
>
>
> [PR#4]: https://github.com/martin-g/avro-website/pull/4
> [PR#6]: https://github.com/martin-g/avro-website/pull/64
> [AVRO-2175]: https://issues.apache.org/jira/browse/AVRO-2175
> [AVRO-3264]: https://issues.apache.org/jira/browse/AVRO-3264
>
> On Tue, Jan 25, 2022 at 9:31 AM Oscar Westra van Holthe - Kind
> <os...@westravanholthe.nl> wrote:
> >
> > Hi all,
> >
> > +1 from me for moving to the new website
> >
> > You've done a great job!
> >
> >
> > --
> > Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>
> >
> > Op di 25 jan. 2022 08:36 schreef Martin Grigorov <mg...@apache.org>:
> >
> > > Hi,
> > >
> > > Shall we replace the old website with the new one ?
> > >
> > > I will have time to work on it next week, so if we decide what to do
> then I
> > > could do it all by myself with my new superpowers (committership!)
> > >
> > > Martin
> > >
> > > On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mg...@apache.org>
> > > wrote:
> > >
> > > >
> > > >
> > > > On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <
> mgrigorov@apache.org>
> > > > wrote:
> > > >
> > > >> Hi Ryan,
> > > >>
> > > >> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com>
> wrote:
> > > >>
> > > >>> Hello!
> > > >>>
> > > >>> I realized that I haven't commented on this mailing list thread --
> I
> > > >>> made some comments on
> https://issues.apache.org/jira/browse/AVRO-2175
> > > >>>
> > > >>> This looks amazing and we should merge it very soon :D It's not
> > > >>> perfect, but it's really a great improvement and definitely not
> worst
> > > >>> than the existing website!
> > > >>>
> > > >>> I've been taking a look at what we need to use the existing
> > > >>> infrastructure, and there's interesting links at:
> > > >>>
> > > >>> - https://infra.apache.org/release-download-pages.html
> > > >>> -
> > > >>>
> > >
> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> > > >>> - https://infra.apache.org/website-guidelines.html
> > > >>> - https://infra.apache.org/project-site.html
> > > >>>
> > > >>> I like that Beam has the website in the main repo, but notably the
> > > >>> INFRA recommendation is that we use a separate repo for the website
> > > >>> (named `avro-site` though). Any thoughts? It's always something
> we
> > > >>> can try and change later! Would it make it easier for the javadoc
> and
> > > >>> other languages if they were in the same repo, or does it make
> little
> > > >>> difference?
> > > >>>
> > > >>
> > > >> Since some docs are generated by other tools (C/C++/C#) and they
> need to
> > > >> be copied to the rest of the website I agree that it would be
> easier if
> > > the
> > > >> website is in the main repo!
> > > >> Also any changes to the spec/IDL will be in one PR (same repo)
> instead
> > > of
> > > >> two (main+website).
> > > >>
> > > >>
> > > >>>
> > > >>> The old site actually contains all of the documentation for EVERY
> > > >>> release, which can be found here:
> > > >>>
> > > >>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> > > >>> - https://avro.apache.org/docs/
> > > >>>
> > > >>> Would it be tricky to adjust your work to mirror the existing
> > > >>> structure for existing docs? I'm not even too fussy about not
> > > >>> breaking the links in /docs/current/ but all of the existing pages
> > > >>> such as /docs/1.7.7/ should be maintained if possible!
> > > >>>
> > > >>
> > > >> I could make the "Documention" nav tab into a dropdown with menu
> items,
> > > >> one for each version.
> > > >> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> > > >> documents. The menu items for all previous versions will be links
> to the
> > > >> respective folder at https://avro.apache.org/docs/.
> > > >>
> > > >
> > > > Done!
> > > > https://avro-website.netlify.app/
> > > >
> > > >
> > > >> If someone wants to migrate some more old docs to Markdown then
> please
> > > >> fork the repo and send a PR!
> > > >>
> > > >>
> > > >>>
> > > >>> There's so many good suggestions here for future work and improving
> > > >>> our message and communication, I created
> > > >>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> > > >>> discussion after we get this up.
> > > >>>
> > > >>> Thanks again for your great work!
> > > >>>
> > > >>> Ryan
> > > >>>
> > > >>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com>
> > > >>> wrote:
> > > >>> >
> > > >>> > I speak only for myself, but I am working in an environment
> where I
> > > am
> > > >>> regularly checking docs all the way back to 1.8.x because we have
> > > legacy
> > > >>> systems we cannot upgrade, and I am often referencing rules about
> > > schema
> > > >>> canonical form. I value a lot the sidebar bottom version switching
> > > >>> navigation from sites such as here
> > > >>>
> > >
> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> > > >>> ... but I know it can be extraordinarily difficult to make it work
> > > >>> correctly with these static site generators.
> > > >>> >
> > > >>> > Lee Hambley
> > > >>> > http://lee.hambley.name/
> > > >>> > +49 (0) 170 298 5667
> > > >>> >
> > > >>> >
> > > >>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <
> mgrigorov@apache.org>
> > > >>> wrote:
> > > >>> >>
> > > >>> >>
> > > >>> >>
> > > >>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com>
> > > >>> wrote:
> > > >>> >>>
> > > >>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
> > > >>> >>> encourage more contributions.
> > > >>> >>> I am more interested on content than aesthetics first. Is
> > > everything
> > > >>> >>> already migrated? Anything missing? Any issue to report?
> > > >>> >>
> > > >>> >>
> > > >>> >> Everything is migrated for the documentation of the *current*
> > > version.
> > > >>> >> The old site contains documentation for both current and
> current-1.
> > > >>> Is this something you would like to preserve ?
> > > >>> >>
> > > >>> >>>
> > > >>> >>>
> > > >>> >>>
> > > >>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <
> > > mgrigorov@apache.org>
> > > >>> wrote:
> > > >>> >>> >
> > > >>> >>> > Hi,
> > > >>> >>> >
> > > >>> >>> > Anyone willing to send a PR with the suggested improvement?
> > > >>> >>> > Or at least open an issue with the well formulated text and I
> > > will
> > > >>> add it!
> > > >>> >>> >
> > > >>> >>> > Regards,
> > > >>> >>> > Martin
> > > >>> >>> >
> > > >>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> > > >>> oscar@westravanholthe.nl> wrote:
> > > >>> >>> >>
> > > >>> >>> >> Hi,
> > > >>> >>> >>
> > > >>> >>> >> This is a huge improvement. Responsive, excellent
> navigation,
> > > >>> syntax
> > > >>> >>> >> highlighting, ...
> > > >>> >>> >>
> > > >>> >>> >> The only downside I see was already mentioned by Lee: the
> > > landing
> > > >>> page is
> > > >>> >>> >> too empty (also in a mobile browser).
> > > >>> >>> >> I think we could really benefit from mentioning the unique
> > > >>> selling point of
> > > >>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then
> mention the
> > > >>> language
> > > >>> >>> >> availability & excellent schema evolution.
> > > >>> >>> >>
> > > >>> >>> >> Kind regards,
> > > >>> >>> >> Oscar
> > > >>> >>> >>
> > > >>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
> > > >>> mgrigorov@apache.org> wrote:
> > > >>> >>> >>
> > > >>> >>> >> > Hi all,
> > > >>> >>> >> >
> > > >>> >>> >> > Please check the new candidate for Apache Avro website:
> > > >>> >>> >> > https://avro-website.netlify.app/
> > > >>> >>> >> >
> > > >>> >>> >> > It is based on Hugo and uses Docsy theme.
> > > >>> >>> >> > Its source code and instructions how to build could be
> found
> > > at
> > > >>> >>> >> > https://github.com/martin-g/avro-website.
> > > >>> >>> >> > The JIRA ticket is:
> > > >>> https://issues.apache.org/jira/browse/AVRO-2175
> > > >>> >>> >> >
> > > >>> >>> >> > I am not web designer, so some things may look not
> finished.
> > > >>> >>> >> > I've just copied the HTML content from the old site (
> > > >>> >>> >> > https://avro.apache.org/) and converted it to Markdown
> for
> > > >>> Hugo.
> > > >>> >>> >> >
> > > >>> >>> >> > Any feedback is welcome! With Pull Requests would be
> awesome!
> > > >>> >>> >> >
> > > >>> >>> >> > Regards,
> > > >>> >>> >> > Martin
> > > >>> >>> >> >
> > > >>>
> > > >>
> > >
>
Re: New website
Posted by Ryan Skraba <ry...@skraba.com>.
Hey there! I'm motivated to see this happen too :D
I suggest that we use AVRO-2175 to track anything we'd like to see
before switching and AVRO-3264 to collect improvements that can wait
until afterwards. I'm convinced that refreshing the site will
encourage others to improve it.
Here are the things that I'd like to see before the switch, almost all
related to deciding where and how to put things:
1) Ensure that we don't break existing links during the migration.
For example https://avro.apache.org/releases.html versus
https://avro-website.netlify.app/project/download/
2) Decide how we are going to deal with existing web resources.
The existing resources under https://avro.apache.org/docs/ are
more-or-less like artifacts from the release, generated from the
release source code. I don't think we should be modifying or removing
them.
The new specification in markdown format should be published for the
next release 1.11.1 or 1.12.0. There's a bit of discussion at [PR#4]
and [PR#6] with dealing with "old" resources -- it's not sustainable
to include them as Hugo static resources.
3) Decide where and how to host what we've built.
Currently, updating the website only happens on a release (there's no
way to see SNAPSHOT documentation), and by manually updating the
contents at https://svn.apache.org/repos/asf/avro/site/publish/
I do like what flink is doing with https://nightlies.apache.org/flink/
(with different versions built and hosted per-minor release and for
master). Would this be the right way to go? How would this work with
the existing structure in svn, or in an asf-site branch or repository?
I'm OK with requiring manual intervention at first, but it would be
great if the nightlies were automated quickly.
All my best and thanks for pushing this forward!
Ryan
[PR#4]: https://github.com/martin-g/avro-website/pull/4
[PR#6]: https://github.com/martin-g/avro-website/pull/64
[AVRO-2175]: https://issues.apache.org/jira/browse/AVRO-2175
[AVRO-3264]: https://issues.apache.org/jira/browse/AVRO-3264
On Tue, Jan 25, 2022 at 9:31 AM Oscar Westra van Holthe - Kind
<os...@westravanholthe.nl> wrote:
>
> Hi all,
>
> +1 from me for moving to the new website
>
> You've done a great job!
>
>
> --
> Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>
>
> Op di 25 jan. 2022 08:36 schreef Martin Grigorov <mg...@apache.org>:
>
> > Hi,
> >
> > Shall we replace the old website with the new one ?
> >
> > I will have time to work on it next week, so if we decide what to do then I
> > could do it all by myself with my new superpowers (committership!)
> >
> > Martin
> >
> > On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mg...@apache.org>
> > wrote:
> >
> > >
> > >
> > > On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mg...@apache.org>
> > > wrote:
> > >
> > >> Hi Ryan,
> > >>
> > >> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
> > >>
> > >>> Hello!
> > >>>
> > >>> I realized that I haven't commented on this mailing list thread -- I
> > >>> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
> > >>>
> > >>> This looks amazing and we should merge it very soon :D It's not
> > >>> perfect, but it's really a great improvement and definitely not worst
> > >>> than the existing website!
> > >>>
> > >>> I've been taking a look at what we need to use the existing
> > >>> infrastructure, and there's interesting links at:
> > >>>
> > >>> - https://infra.apache.org/release-download-pages.html
> > >>> -
> > >>>
> > https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> > >>> - https://infra.apache.org/website-guidelines.html
> > >>> - https://infra.apache.org/project-site.html
> > >>>
> > >>> I like that Beam has the website in the main repo, but notably the
> > >>> INFRA recommendation is that we use a separate repo for the website
> > >>> (named `avro-site` though). Any thoughts? It's always something we
> > >>> can try and change later! Would it make it easier for the javadoc and
> > >>> other languages if they were in the same repo, or does it make little
> > >>> difference?
> > >>>
> > >>
> > >> Since some docs are generated by other tools (C/C++/C#) and they need to
> > >> be copied to the rest of the website I agree that it would be easier if
> > the
> > >> website is in the main repo!
> > >> Also any changes to the spec/IDL will be in one PR (same repo) instead
> > of
> > >> two (main+website).
> > >>
> > >>
> > >>>
> > >>> The old site actually contains all of the documentation for EVERY
> > >>> release, which can be found here:
> > >>>
> > >>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> > >>> - https://avro.apache.org/docs/
> > >>>
> > >>> Would it be tricky to adjust your work to mirror the existing
> > >>> structure for existing docs? I'm not even too fussy about not
> > >>> breaking the links in /docs/current/ but all of the existing pages
> > >>> such as /docs/1.7.7/ should be maintained if possible!
> > >>>
> > >>
> > >> I could make the "Documention" nav tab into a dropdown with menu items,
> > >> one for each version.
> > >> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> > >> documents. The menu items for all previous versions will be links to the
> > >> respective folder at https://avro.apache.org/docs/.
> > >>
> > >
> > > Done!
> > > https://avro-website.netlify.app/
> > >
> > >
> > >> If someone wants to migrate some more old docs to Markdown then please
> > >> fork the repo and send a PR!
> > >>
> > >>
> > >>>
> > >>> There's so many good suggestions here for future work and improving
> > >>> our message and communication, I created
> > >>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> > >>> discussion after we get this up.
> > >>>
> > >>> Thanks again for your great work!
> > >>>
> > >>> Ryan
> > >>>
> > >>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com>
> > >>> wrote:
> > >>> >
> > >>> > I speak only for myself, but I am working in an environment where I
> > am
> > >>> regularly checking docs all the way back to 1.8.x because we have
> > legacy
> > >>> systems we cannot upgrade, and I am often referencing rules about
> > schema
> > >>> canonical form. I value a lot the sidebar bottom version switching
> > >>> navigation from sites such as here
> > >>>
> > https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> > >>> ... but I know it can be extraordinarily difficult to make it work
> > >>> correctly with these static site generators.
> > >>> >
> > >>> > Lee Hambley
> > >>> > http://lee.hambley.name/
> > >>> > +49 (0) 170 298 5667
> > >>> >
> > >>> >
> > >>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
> > >>> wrote:
> > >>> >>
> > >>> >>
> > >>> >>
> > >>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com>
> > >>> wrote:
> > >>> >>>
> > >>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
> > >>> >>> encourage more contributions.
> > >>> >>> I am more interested on content than aesthetics first. Is
> > everything
> > >>> >>> already migrated? Anything missing? Any issue to report?
> > >>> >>
> > >>> >>
> > >>> >> Everything is migrated for the documentation of the *current*
> > version.
> > >>> >> The old site contains documentation for both current and current-1.
> > >>> Is this something you would like to preserve ?
> > >>> >>
> > >>> >>>
> > >>> >>>
> > >>> >>>
> > >>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <
> > mgrigorov@apache.org>
> > >>> wrote:
> > >>> >>> >
> > >>> >>> > Hi,
> > >>> >>> >
> > >>> >>> > Anyone willing to send a PR with the suggested improvement?
> > >>> >>> > Or at least open an issue with the well formulated text and I
> > will
> > >>> add it!
> > >>> >>> >
> > >>> >>> > Regards,
> > >>> >>> > Martin
> > >>> >>> >
> > >>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> > >>> oscar@westravanholthe.nl> wrote:
> > >>> >>> >>
> > >>> >>> >> Hi,
> > >>> >>> >>
> > >>> >>> >> This is a huge improvement. Responsive, excellent navigation,
> > >>> syntax
> > >>> >>> >> highlighting, ...
> > >>> >>> >>
> > >>> >>> >> The only downside I see was already mentioned by Lee: the
> > landing
> > >>> page is
> > >>> >>> >> too empty (also in a mobile browser).
> > >>> >>> >> I think we could really benefit from mentioning the unique
> > >>> selling point of
> > >>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> > >>> language
> > >>> >>> >> availability & excellent schema evolution.
> > >>> >>> >>
> > >>> >>> >> Kind regards,
> > >>> >>> >> Oscar
> > >>> >>> >>
> > >>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
> > >>> mgrigorov@apache.org> wrote:
> > >>> >>> >>
> > >>> >>> >> > Hi all,
> > >>> >>> >> >
> > >>> >>> >> > Please check the new candidate for Apache Avro website:
> > >>> >>> >> > https://avro-website.netlify.app/
> > >>> >>> >> >
> > >>> >>> >> > It is based on Hugo and uses Docsy theme.
> > >>> >>> >> > Its source code and instructions how to build could be found
> > at
> > >>> >>> >> > https://github.com/martin-g/avro-website.
> > >>> >>> >> > The JIRA ticket is:
> > >>> https://issues.apache.org/jira/browse/AVRO-2175
> > >>> >>> >> >
> > >>> >>> >> > I am not web designer, so some things may look not finished.
> > >>> >>> >> > I've just copied the HTML content from the old site (
> > >>> >>> >> > https://avro.apache.org/) and converted it to Markdown for
> > >>> Hugo.
> > >>> >>> >> >
> > >>> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
> > >>> >>> >> >
> > >>> >>> >> > Regards,
> > >>> >>> >> > Martin
> > >>> >>> >> >
> > >>>
> > >>
> >
Re: New website
Posted by Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>.
Hi all,
+1 from me for moving to the new website
You've done a great job!
--
Oscar Westra van Holthe - Kind <os...@westravanholthe.nl>
Op di 25 jan. 2022 08:36 schreef Martin Grigorov <mg...@apache.org>:
> Hi,
>
> Shall we replace the old website with the new one ?
>
> I will have time to work on it next week, so if we decide what to do then I
> could do it all by myself with my new superpowers (committership!)
>
> Martin
>
> On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mg...@apache.org>
> wrote:
>
> >
> >
> > On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mg...@apache.org>
> > wrote:
> >
> >> Hi Ryan,
> >>
> >> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
> >>
> >>> Hello!
> >>>
> >>> I realized that I haven't commented on this mailing list thread -- I
> >>> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
> >>>
> >>> This looks amazing and we should merge it very soon :D It's not
> >>> perfect, but it's really a great improvement and definitely not worst
> >>> than the existing website!
> >>>
> >>> I've been taking a look at what we need to use the existing
> >>> infrastructure, and there's interesting links at:
> >>>
> >>> - https://infra.apache.org/release-download-pages.html
> >>> -
> >>>
> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> >>> - https://infra.apache.org/website-guidelines.html
> >>> - https://infra.apache.org/project-site.html
> >>>
> >>> I like that Beam has the website in the main repo, but notably the
> >>> INFRA recommendation is that we use a separate repo for the website
> >>> (named `avro-site` though). Any thoughts? It's always something we
> >>> can try and change later! Would it make it easier for the javadoc and
> >>> other languages if they were in the same repo, or does it make little
> >>> difference?
> >>>
> >>
> >> Since some docs are generated by other tools (C/C++/C#) and they need to
> >> be copied to the rest of the website I agree that it would be easier if
> the
> >> website is in the main repo!
> >> Also any changes to the spec/IDL will be in one PR (same repo) instead
> of
> >> two (main+website).
> >>
> >>
> >>>
> >>> The old site actually contains all of the documentation for EVERY
> >>> release, which can be found here:
> >>>
> >>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> >>> - https://avro.apache.org/docs/
> >>>
> >>> Would it be tricky to adjust your work to mirror the existing
> >>> structure for existing docs? I'm not even too fussy about not
> >>> breaking the links in /docs/current/ but all of the existing pages
> >>> such as /docs/1.7.7/ should be maintained if possible!
> >>>
> >>
> >> I could make the "Documention" nav tab into a dropdown with menu items,
> >> one for each version.
> >> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> >> documents. The menu items for all previous versions will be links to the
> >> respective folder at https://avro.apache.org/docs/.
> >>
> >
> > Done!
> > https://avro-website.netlify.app/
> >
> >
> >> If someone wants to migrate some more old docs to Markdown then please
> >> fork the repo and send a PR!
> >>
> >>
> >>>
> >>> There's so many good suggestions here for future work and improving
> >>> our message and communication, I created
> >>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> >>> discussion after we get this up.
> >>>
> >>> Thanks again for your great work!
> >>>
> >>> Ryan
> >>>
> >>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com>
> >>> wrote:
> >>> >
> >>> > I speak only for myself, but I am working in an environment where I
> am
> >>> regularly checking docs all the way back to 1.8.x because we have
> legacy
> >>> systems we cannot upgrade, and I am often referencing rules about
> schema
> >>> canonical form. I value a lot the sidebar bottom version switching
> >>> navigation from sites such as here
> >>>
> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> >>> ... but I know it can be extraordinarily difficult to make it work
> >>> correctly with these static site generators.
> >>> >
> >>> > Lee Hambley
> >>> > http://lee.hambley.name/
> >>> > +49 (0) 170 298 5667
> >>> >
> >>> >
> >>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
> >>> wrote:
> >>> >>
> >>> >>
> >>> >>
> >>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com>
> >>> wrote:
> >>> >>>
> >>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
> >>> >>> encourage more contributions.
> >>> >>> I am more interested on content than aesthetics first. Is
> everything
> >>> >>> already migrated? Anything missing? Any issue to report?
> >>> >>
> >>> >>
> >>> >> Everything is migrated for the documentation of the *current*
> version.
> >>> >> The old site contains documentation for both current and current-1.
> >>> Is this something you would like to preserve ?
> >>> >>
> >>> >>>
> >>> >>>
> >>> >>>
> >>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <
> mgrigorov@apache.org>
> >>> wrote:
> >>> >>> >
> >>> >>> > Hi,
> >>> >>> >
> >>> >>> > Anyone willing to send a PR with the suggested improvement?
> >>> >>> > Or at least open an issue with the well formulated text and I
> will
> >>> add it!
> >>> >>> >
> >>> >>> > Regards,
> >>> >>> > Martin
> >>> >>> >
> >>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> >>> oscar@westravanholthe.nl> wrote:
> >>> >>> >>
> >>> >>> >> Hi,
> >>> >>> >>
> >>> >>> >> This is a huge improvement. Responsive, excellent navigation,
> >>> syntax
> >>> >>> >> highlighting, ...
> >>> >>> >>
> >>> >>> >> The only downside I see was already mentioned by Lee: the
> landing
> >>> page is
> >>> >>> >> too empty (also in a mobile browser).
> >>> >>> >> I think we could really benefit from mentioning the unique
> >>> selling point of
> >>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> >>> language
> >>> >>> >> availability & excellent schema evolution.
> >>> >>> >>
> >>> >>> >> Kind regards,
> >>> >>> >> Oscar
> >>> >>> >>
> >>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
> >>> mgrigorov@apache.org> wrote:
> >>> >>> >>
> >>> >>> >> > Hi all,
> >>> >>> >> >
> >>> >>> >> > Please check the new candidate for Apache Avro website:
> >>> >>> >> > https://avro-website.netlify.app/
> >>> >>> >> >
> >>> >>> >> > It is based on Hugo and uses Docsy theme.
> >>> >>> >> > Its source code and instructions how to build could be found
> at
> >>> >>> >> > https://github.com/martin-g/avro-website.
> >>> >>> >> > The JIRA ticket is:
> >>> https://issues.apache.org/jira/browse/AVRO-2175
> >>> >>> >> >
> >>> >>> >> > I am not web designer, so some things may look not finished.
> >>> >>> >> > I've just copied the HTML content from the old site (
> >>> >>> >> > https://avro.apache.org/) and converted it to Markdown for
> >>> Hugo.
> >>> >>> >> >
> >>> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
> >>> >>> >> >
> >>> >>> >> > Regards,
> >>> >>> >> > Martin
> >>> >>> >> >
> >>>
> >>
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi,
Shall we replace the old website with the new one ?
I will have time to work on it next week, so if we decide what to do then I
could do it all by myself with my new superpowers (committership!)
Martin
On Mon, Dec 13, 2021 at 1:51 PM Martin Grigorov <mg...@apache.org>
wrote:
>
>
> On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mg...@apache.org>
> wrote:
>
>> Hi Ryan,
>>
>> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
>>
>>> Hello!
>>>
>>> I realized that I haven't commented on this mailing list thread -- I
>>> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
>>>
>>> This looks amazing and we should merge it very soon :D It's not
>>> perfect, but it's really a great improvement and definitely not worst
>>> than the existing website!
>>>
>>> I've been taking a look at what we need to use the existing
>>> infrastructure, and there's interesting links at:
>>>
>>> - https://infra.apache.org/release-download-pages.html
>>> -
>>> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
>>> - https://infra.apache.org/website-guidelines.html
>>> - https://infra.apache.org/project-site.html
>>>
>>> I like that Beam has the website in the main repo, but notably the
>>> INFRA recommendation is that we use a separate repo for the website
>>> (named `avro-site` though). Any thoughts? It's always something we
>>> can try and change later! Would it make it easier for the javadoc and
>>> other languages if they were in the same repo, or does it make little
>>> difference?
>>>
>>
>> Since some docs are generated by other tools (C/C++/C#) and they need to
>> be copied to the rest of the website I agree that it would be easier if the
>> website is in the main repo!
>> Also any changes to the spec/IDL will be in one PR (same repo) instead of
>> two (main+website).
>>
>>
>>>
>>> The old site actually contains all of the documentation for EVERY
>>> release, which can be found here:
>>>
>>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
>>> - https://avro.apache.org/docs/
>>>
>>> Would it be tricky to adjust your work to mirror the existing
>>> structure for existing docs? I'm not even too fussy about not
>>> breaking the links in /docs/current/ but all of the existing pages
>>> such as /docs/1.7.7/ should be maintained if possible!
>>>
>>
>> I could make the "Documention" nav tab into a dropdown with menu items,
>> one for each version.
>> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
>> documents. The menu items for all previous versions will be links to the
>> respective folder at https://avro.apache.org/docs/.
>>
>
> Done!
> https://avro-website.netlify.app/
>
>
>> If someone wants to migrate some more old docs to Markdown then please
>> fork the repo and send a PR!
>>
>>
>>>
>>> There's so many good suggestions here for future work and improving
>>> our message and communication, I created
>>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
>>> discussion after we get this up.
>>>
>>> Thanks again for your great work!
>>>
>>> Ryan
>>>
>>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com>
>>> wrote:
>>> >
>>> > I speak only for myself, but I am working in an environment where I am
>>> regularly checking docs all the way back to 1.8.x because we have legacy
>>> systems we cannot upgrade, and I am often referencing rules about schema
>>> canonical form. I value a lot the sidebar bottom version switching
>>> navigation from sites such as here
>>> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
>>> ... but I know it can be extraordinarily difficult to make it work
>>> correctly with these static site generators.
>>> >
>>> > Lee Hambley
>>> > http://lee.hambley.name/
>>> > +49 (0) 170 298 5667
>>> >
>>> >
>>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
>>> wrote:
>>> >>
>>> >>
>>> >>
>>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com>
>>> wrote:
>>> >>>
>>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
>>> >>> encourage more contributions.
>>> >>> I am more interested on content than aesthetics first. Is everything
>>> >>> already migrated? Anything missing? Any issue to report?
>>> >>
>>> >>
>>> >> Everything is migrated for the documentation of the *current* version.
>>> >> The old site contains documentation for both current and current-1.
>>> Is this something you would like to preserve ?
>>> >>
>>> >>>
>>> >>>
>>> >>>
>>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
>>> wrote:
>>> >>> >
>>> >>> > Hi,
>>> >>> >
>>> >>> > Anyone willing to send a PR with the suggested improvement?
>>> >>> > Or at least open an issue with the well formulated text and I will
>>> add it!
>>> >>> >
>>> >>> > Regards,
>>> >>> > Martin
>>> >>> >
>>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
>>> oscar@westravanholthe.nl> wrote:
>>> >>> >>
>>> >>> >> Hi,
>>> >>> >>
>>> >>> >> This is a huge improvement. Responsive, excellent navigation,
>>> syntax
>>> >>> >> highlighting, ...
>>> >>> >>
>>> >>> >> The only downside I see was already mentioned by Lee: the landing
>>> page is
>>> >>> >> too empty (also in a mobile browser).
>>> >>> >> I think we could really benefit from mentioning the unique
>>> selling point of
>>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
>>> language
>>> >>> >> availability & excellent schema evolution.
>>> >>> >>
>>> >>> >> Kind regards,
>>> >>> >> Oscar
>>> >>> >>
>>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
>>> mgrigorov@apache.org> wrote:
>>> >>> >>
>>> >>> >> > Hi all,
>>> >>> >> >
>>> >>> >> > Please check the new candidate for Apache Avro website:
>>> >>> >> > https://avro-website.netlify.app/
>>> >>> >> >
>>> >>> >> > It is based on Hugo and uses Docsy theme.
>>> >>> >> > Its source code and instructions how to build could be found at
>>> >>> >> > https://github.com/martin-g/avro-website.
>>> >>> >> > The JIRA ticket is:
>>> https://issues.apache.org/jira/browse/AVRO-2175
>>> >>> >> >
>>> >>> >> > I am not web designer, so some things may look not finished.
>>> >>> >> > I've just copied the HTML content from the old site (
>>> >>> >> > https://avro.apache.org/) and converted it to Markdown for
>>> Hugo.
>>> >>> >> >
>>> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>>> >>> >> >
>>> >>> >> > Regards,
>>> >>> >> > Martin
>>> >>> >> >
>>>
>>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mg...@apache.org>
wrote:
> Hi Ryan,
>
> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
>
>> Hello!
>>
>> I realized that I haven't commented on this mailing list thread -- I
>> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
>>
>> This looks amazing and we should merge it very soon :D It's not
>> perfect, but it's really a great improvement and definitely not worst
>> than the existing website!
>>
>> I've been taking a look at what we need to use the existing
>> infrastructure, and there's interesting links at:
>>
>> - https://infra.apache.org/release-download-pages.html
>> -
>> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
>> - https://infra.apache.org/website-guidelines.html
>> - https://infra.apache.org/project-site.html
>>
>> I like that Beam has the website in the main repo, but notably the
>> INFRA recommendation is that we use a separate repo for the website
>> (named `avro-site` though). Any thoughts? It's always something we
>> can try and change later! Would it make it easier for the javadoc and
>> other languages if they were in the same repo, or does it make little
>> difference?
>>
>
> Since some docs are generated by other tools (C/C++/C#) and they need to
> be copied to the rest of the website I agree that it would be easier if the
> website is in the main repo!
> Also any changes to the spec/IDL will be in one PR (same repo) instead of
> two (main+website).
>
>
>>
>> The old site actually contains all of the documentation for EVERY
>> release, which can be found here:
>>
>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
>> - https://avro.apache.org/docs/
>>
>> Would it be tricky to adjust your work to mirror the existing
>> structure for existing docs? I'm not even too fussy about not
>> breaking the links in /docs/current/ but all of the existing pages
>> such as /docs/1.7.7/ should be maintained if possible!
>>
>
> I could make the "Documention" nav tab into a dropdown with menu items,
> one for each version.
> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> documents. The menu items for all previous versions will be links to the
> respective folder at https://avro.apache.org/docs/.
>
Done!
https://avro-website.netlify.app/
> If someone wants to migrate some more old docs to Markdown then please
> fork the repo and send a PR!
>
>
>>
>> There's so many good suggestions here for future work and improving
>> our message and communication, I created
>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
>> discussion after we get this up.
>>
>> Thanks again for your great work!
>>
>> Ryan
>>
>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
>> >
>> > I speak only for myself, but I am working in an environment where I am
>> regularly checking docs all the way back to 1.8.x because we have legacy
>> systems we cannot upgrade, and I am often referencing rules about schema
>> canonical form. I value a lot the sidebar bottom version switching
>> navigation from sites such as here
>> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
>> ... but I know it can be extraordinarily difficult to make it work
>> correctly with these static site generators.
>> >
>> > Lee Hambley
>> > http://lee.hambley.name/
>> > +49 (0) 170 298 5667
>> >
>> >
>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
>> wrote:
>> >>
>> >>
>> >>
>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
>> >>>
>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
>> >>> encourage more contributions.
>> >>> I am more interested on content than aesthetics first. Is everything
>> >>> already migrated? Anything missing? Any issue to report?
>> >>
>> >>
>> >> Everything is migrated for the documentation of the *current* version.
>> >> The old site contains documentation for both current and current-1. Is
>> this something you would like to preserve ?
>> >>
>> >>>
>> >>>
>> >>>
>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
>> wrote:
>> >>> >
>> >>> > Hi,
>> >>> >
>> >>> > Anyone willing to send a PR with the suggested improvement?
>> >>> > Or at least open an issue with the well formulated text and I will
>> add it!
>> >>> >
>> >>> > Regards,
>> >>> > Martin
>> >>> >
>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
>> oscar@westravanholthe.nl> wrote:
>> >>> >>
>> >>> >> Hi,
>> >>> >>
>> >>> >> This is a huge improvement. Responsive, excellent navigation,
>> syntax
>> >>> >> highlighting, ...
>> >>> >>
>> >>> >> The only downside I see was already mentioned by Lee: the landing
>> page is
>> >>> >> too empty (also in a mobile browser).
>> >>> >> I think we could really benefit from mentioning the unique selling
>> point of
>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
>> language
>> >>> >> availability & excellent schema evolution.
>> >>> >>
>> >>> >> Kind regards,
>> >>> >> Oscar
>> >>> >>
>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
>> mgrigorov@apache.org> wrote:
>> >>> >>
>> >>> >> > Hi all,
>> >>> >> >
>> >>> >> > Please check the new candidate for Apache Avro website:
>> >>> >> > https://avro-website.netlify.app/
>> >>> >> >
>> >>> >> > It is based on Hugo and uses Docsy theme.
>> >>> >> > Its source code and instructions how to build could be found at
>> >>> >> > https://github.com/martin-g/avro-website.
>> >>> >> > The JIRA ticket is:
>> https://issues.apache.org/jira/browse/AVRO-2175
>> >>> >> >
>> >>> >> > I am not web designer, so some things may look not finished.
>> >>> >> > I've just copied the HTML content from the old site (
>> >>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>> >>> >> >
>> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>> >>> >> >
>> >>> >> > Regards,
>> >>> >> > Martin
>> >>> >> >
>>
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mg...@apache.org>
wrote:
> Hi Ryan,
>
> On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
>
>> Hello!
>>
>> I realized that I haven't commented on this mailing list thread -- I
>> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
>>
>> This looks amazing and we should merge it very soon :D It's not
>> perfect, but it's really a great improvement and definitely not worst
>> than the existing website!
>>
>> I've been taking a look at what we need to use the existing
>> infrastructure, and there's interesting links at:
>>
>> - https://infra.apache.org/release-download-pages.html
>> -
>> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
>> - https://infra.apache.org/website-guidelines.html
>> - https://infra.apache.org/project-site.html
>>
>> I like that Beam has the website in the main repo, but notably the
>> INFRA recommendation is that we use a separate repo for the website
>> (named `avro-site` though). Any thoughts? It's always something we
>> can try and change later! Would it make it easier for the javadoc and
>> other languages if they were in the same repo, or does it make little
>> difference?
>>
>
> Since some docs are generated by other tools (C/C++/C#) and they need to
> be copied to the rest of the website I agree that it would be easier if the
> website is in the main repo!
> Also any changes to the spec/IDL will be in one PR (same repo) instead of
> two (main+website).
>
>
>>
>> The old site actually contains all of the documentation for EVERY
>> release, which can be found here:
>>
>> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
>> - https://avro.apache.org/docs/
>>
>> Would it be tricky to adjust your work to mirror the existing
>> structure for existing docs? I'm not even too fussy about not
>> breaking the links in /docs/current/ but all of the existing pages
>> such as /docs/1.7.7/ should be maintained if possible!
>>
>
> I could make the "Documention" nav tab into a dropdown with menu items,
> one for each version.
> 1.11.0 and 1.10.2, and any future release, will be proper Markdown
> documents. The menu items for all previous versions will be links to the
> respective folder at https://avro.apache.org/docs/.
>
Done!
https://avro-website.netlify.app/
> If someone wants to migrate some more old docs to Markdown then please
> fork the repo and send a PR!
>
>
>>
>> There's so many good suggestions here for future work and improving
>> our message and communication, I created
>> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
>> discussion after we get this up.
>>
>> Thanks again for your great work!
>>
>> Ryan
>>
>> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
>> >
>> > I speak only for myself, but I am working in an environment where I am
>> regularly checking docs all the way back to 1.8.x because we have legacy
>> systems we cannot upgrade, and I am often referencing rules about schema
>> canonical form. I value a lot the sidebar bottom version switching
>> navigation from sites such as here
>> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
>> ... but I know it can be extraordinarily difficult to make it work
>> correctly with these static site generators.
>> >
>> > Lee Hambley
>> > http://lee.hambley.name/
>> > +49 (0) 170 298 5667
>> >
>> >
>> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
>> wrote:
>> >>
>> >>
>> >>
>> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
>> >>>
>> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
>> >>> encourage more contributions.
>> >>> I am more interested on content than aesthetics first. Is everything
>> >>> already migrated? Anything missing? Any issue to report?
>> >>
>> >>
>> >> Everything is migrated for the documentation of the *current* version.
>> >> The old site contains documentation for both current and current-1. Is
>> this something you would like to preserve ?
>> >>
>> >>>
>> >>>
>> >>>
>> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
>> wrote:
>> >>> >
>> >>> > Hi,
>> >>> >
>> >>> > Anyone willing to send a PR with the suggested improvement?
>> >>> > Or at least open an issue with the well formulated text and I will
>> add it!
>> >>> >
>> >>> > Regards,
>> >>> > Martin
>> >>> >
>> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
>> oscar@westravanholthe.nl> wrote:
>> >>> >>
>> >>> >> Hi,
>> >>> >>
>> >>> >> This is a huge improvement. Responsive, excellent navigation,
>> syntax
>> >>> >> highlighting, ...
>> >>> >>
>> >>> >> The only downside I see was already mentioned by Lee: the landing
>> page is
>> >>> >> too empty (also in a mobile browser).
>> >>> >> I think we could really benefit from mentioning the unique selling
>> point of
>> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
>> language
>> >>> >> availability & excellent schema evolution.
>> >>> >>
>> >>> >> Kind regards,
>> >>> >> Oscar
>> >>> >>
>> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <
>> mgrigorov@apache.org> wrote:
>> >>> >>
>> >>> >> > Hi all,
>> >>> >> >
>> >>> >> > Please check the new candidate for Apache Avro website:
>> >>> >> > https://avro-website.netlify.app/
>> >>> >> >
>> >>> >> > It is based on Hugo and uses Docsy theme.
>> >>> >> > Its source code and instructions how to build could be found at
>> >>> >> > https://github.com/martin-g/avro-website.
>> >>> >> > The JIRA ticket is:
>> https://issues.apache.org/jira/browse/AVRO-2175
>> >>> >> >
>> >>> >> > I am not web designer, so some things may look not finished.
>> >>> >> > I've just copied the HTML content from the old site (
>> >>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>> >>> >> >
>> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>> >>> >> >
>> >>> >> > Regards,
>> >>> >> > Martin
>> >>> >> >
>>
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi Ryan,
On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
> Hello!
>
> I realized that I haven't commented on this mailing list thread -- I
> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
>
> This looks amazing and we should merge it very soon :D It's not
> perfect, but it's really a great improvement and definitely not worst
> than the existing website!
>
> I've been taking a look at what we need to use the existing
> infrastructure, and there's interesting links at:
>
> - https://infra.apache.org/release-download-pages.html
> -
> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> - https://infra.apache.org/website-guidelines.html
> - https://infra.apache.org/project-site.html
>
> I like that Beam has the website in the main repo, but notably the
> INFRA recommendation is that we use a separate repo for the website
> (named `avro-site` though). Any thoughts? It's always something we
> can try and change later! Would it make it easier for the javadoc and
> other languages if they were in the same repo, or does it make little
> difference?
>
Since some docs are generated by other tools (C/C++/C#) and they need to be
copied to the rest of the website I agree that it would be easier if the
website is in the main repo!
Also any changes to the spec/IDL will be in one PR (same repo) instead of
two (main+website).
>
> The old site actually contains all of the documentation for EVERY
> release, which can be found here:
>
> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> - https://avro.apache.org/docs/
>
> Would it be tricky to adjust your work to mirror the existing
> structure for existing docs? I'm not even too fussy about not
> breaking the links in /docs/current/ but all of the existing pages
> such as /docs/1.7.7/ should be maintained if possible!
>
I could make the "Documention" nav tab into a dropdown with menu items, one
for each version.
1.11.0 and 1.10.2, and any future release, will be proper Markdown
documents. The menu items for all previous versions will be links to the
respective folder at https://avro.apache.org/docs/.
If someone wants to migrate some more old docs to Markdown then please fork
the repo and send a PR!
>
> There's so many good suggestions here for future work and improving
> our message and communication, I created
> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> discussion after we get this up.
>
> Thanks again for your great work!
>
> Ryan
>
> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
> >
> > I speak only for myself, but I am working in an environment where I am
> regularly checking docs all the way back to 1.8.x because we have legacy
> systems we cannot upgrade, and I am often referencing rules about schema
> canonical form. I value a lot the sidebar bottom version switching
> navigation from sites such as here
> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> ... but I know it can be extraordinarily difficult to make it work
> correctly with these static site generators.
> >
> > Lee Hambley
> > http://lee.hambley.name/
> > +49 (0) 170 298 5667
> >
> >
> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
> wrote:
> >>
> >>
> >>
> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
> >>>
> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
> >>> encourage more contributions.
> >>> I am more interested on content than aesthetics first. Is everything
> >>> already migrated? Anything missing? Any issue to report?
> >>
> >>
> >> Everything is migrated for the documentation of the *current* version.
> >> The old site contains documentation for both current and current-1. Is
> this something you would like to preserve ?
> >>
> >>>
> >>>
> >>>
> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
> wrote:
> >>> >
> >>> > Hi,
> >>> >
> >>> > Anyone willing to send a PR with the suggested improvement?
> >>> > Or at least open an issue with the well formulated text and I will
> add it!
> >>> >
> >>> > Regards,
> >>> > Martin
> >>> >
> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> oscar@westravanholthe.nl> wrote:
> >>> >>
> >>> >> Hi,
> >>> >>
> >>> >> This is a huge improvement. Responsive, excellent navigation, syntax
> >>> >> highlighting, ...
> >>> >>
> >>> >> The only downside I see was already mentioned by Lee: the landing
> page is
> >>> >> too empty (also in a mobile browser).
> >>> >> I think we could really benefit from mentioning the unique selling
> point of
> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> language
> >>> >> availability & excellent schema evolution.
> >>> >>
> >>> >> Kind regards,
> >>> >> Oscar
> >>> >>
> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
> >>> >>
> >>> >> > Hi all,
> >>> >> >
> >>> >> > Please check the new candidate for Apache Avro website:
> >>> >> > https://avro-website.netlify.app/
> >>> >> >
> >>> >> > It is based on Hugo and uses Docsy theme.
> >>> >> > Its source code and instructions how to build could be found at
> >>> >> > https://github.com/martin-g/avro-website.
> >>> >> > The JIRA ticket is:
> https://issues.apache.org/jira/browse/AVRO-2175
> >>> >> >
> >>> >> > I am not web designer, so some things may look not finished.
> >>> >> > I've just copied the HTML content from the old site (
> >>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >>> >> >
> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
> >>> >> >
> >>> >> > Regards,
> >>> >> > Martin
> >>> >> >
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi Ryan,
On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <ry...@skraba.com> wrote:
> Hello!
>
> I realized that I haven't commented on this mailing list thread -- I
> made some comments on https://issues.apache.org/jira/browse/AVRO-2175
>
> This looks amazing and we should merge it very soon :D It's not
> perfect, but it's really a great improvement and definitely not worst
> than the existing website!
>
> I've been taking a look at what we need to use the existing
> infrastructure, and there's interesting links at:
>
> - https://infra.apache.org/release-download-pages.html
> -
> https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
> - https://infra.apache.org/website-guidelines.html
> - https://infra.apache.org/project-site.html
>
> I like that Beam has the website in the main repo, but notably the
> INFRA recommendation is that we use a separate repo for the website
> (named `avro-site` though). Any thoughts? It's always something we
> can try and change later! Would it make it easier for the javadoc and
> other languages if they were in the same repo, or does it make little
> difference?
>
Since some docs are generated by other tools (C/C++/C#) and they need to be
copied to the rest of the website I agree that it would be easier if the
website is in the main repo!
Also any changes to the spec/IDL will be in one PR (same repo) instead of
two (main+website).
>
> The old site actually contains all of the documentation for EVERY
> release, which can be found here:
>
> - https://svn.apache.org/repos/asf/avro/site/publish/docs/
> - https://avro.apache.org/docs/
>
> Would it be tricky to adjust your work to mirror the existing
> structure for existing docs? I'm not even too fussy about not
> breaking the links in /docs/current/ but all of the existing pages
> such as /docs/1.7.7/ should be maintained if possible!
>
I could make the "Documention" nav tab into a dropdown with menu items, one
for each version.
1.11.0 and 1.10.2, and any future release, will be proper Markdown
documents. The menu items for all previous versions will be links to the
respective folder at https://avro.apache.org/docs/.
If someone wants to migrate some more old docs to Markdown then please fork
the repo and send a PR!
>
> There's so many good suggestions here for future work and improving
> our message and communication, I created
> https://issues.apache.org/jira/browse/AVRO-3264 to point to this
> discussion after we get this up.
>
> Thanks again for your great work!
>
> Ryan
>
> On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
> >
> > I speak only for myself, but I am working in an environment where I am
> regularly checking docs all the way back to 1.8.x because we have legacy
> systems we cannot upgrade, and I am often referencing rules about schema
> canonical form. I value a lot the sidebar bottom version switching
> navigation from sites such as here
> https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
> ... but I know it can be extraordinarily difficult to make it work
> correctly with these static site generators.
> >
> > Lee Hambley
> > http://lee.hambley.name/
> > +49 (0) 170 298 5667
> >
> >
> > On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org>
> wrote:
> >>
> >>
> >>
> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
> >>>
> >>> Wow this is pretty neat ! Nice job Martin! A modern website can
> >>> encourage more contributions.
> >>> I am more interested on content than aesthetics first. Is everything
> >>> already migrated? Anything missing? Any issue to report?
> >>
> >>
> >> Everything is migrated for the documentation of the *current* version.
> >> The old site contains documentation for both current and current-1. Is
> this something you would like to preserve ?
> >>
> >>>
> >>>
> >>>
> >>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
> wrote:
> >>> >
> >>> > Hi,
> >>> >
> >>> > Anyone willing to send a PR with the suggested improvement?
> >>> > Or at least open an issue with the well formulated text and I will
> add it!
> >>> >
> >>> > Regards,
> >>> > Martin
> >>> >
> >>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> oscar@westravanholthe.nl> wrote:
> >>> >>
> >>> >> Hi,
> >>> >>
> >>> >> This is a huge improvement. Responsive, excellent navigation, syntax
> >>> >> highlighting, ...
> >>> >>
> >>> >> The only downside I see was already mentioned by Lee: the landing
> page is
> >>> >> too empty (also in a mobile browser).
> >>> >> I think we could really benefit from mentioning the unique selling
> point of
> >>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> language
> >>> >> availability & excellent schema evolution.
> >>> >>
> >>> >> Kind regards,
> >>> >> Oscar
> >>> >>
> >>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
> >>> >>
> >>> >> > Hi all,
> >>> >> >
> >>> >> > Please check the new candidate for Apache Avro website:
> >>> >> > https://avro-website.netlify.app/
> >>> >> >
> >>> >> > It is based on Hugo and uses Docsy theme.
> >>> >> > Its source code and instructions how to build could be found at
> >>> >> > https://github.com/martin-g/avro-website.
> >>> >> > The JIRA ticket is:
> https://issues.apache.org/jira/browse/AVRO-2175
> >>> >> >
> >>> >> > I am not web designer, so some things may look not finished.
> >>> >> > I've just copied the HTML content from the old site (
> >>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >>> >> >
> >>> >> > Any feedback is welcome! With Pull Requests would be awesome!
> >>> >> >
> >>> >> > Regards,
> >>> >> > Martin
> >>> >> >
>
Re: New website
Posted by Ryan Skraba <ry...@skraba.com>.
Hello!
I realized that I haven't commented on this mailing list thread -- I
made some comments on https://issues.apache.org/jira/browse/AVRO-2175
This looks amazing and we should merge it very soon :D It's not
perfect, but it's really a great improvement and definitely not worst
than the existing website!
I've been taking a look at what we need to use the existing
infrastructure, and there's interesting links at:
- https://infra.apache.org/release-download-pages.html
- https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
- https://infra.apache.org/website-guidelines.html
- https://infra.apache.org/project-site.html
I like that Beam has the website in the main repo, but notably the
INFRA recommendation is that we use a separate repo for the website
(named `avro-site` though). Any thoughts? It's always something we
can try and change later! Would it make it easier for the javadoc and
other languages if they were in the same repo, or does it make little
difference?
The old site actually contains all of the documentation for EVERY
release, which can be found here:
- https://svn.apache.org/repos/asf/avro/site/publish/docs/
- https://avro.apache.org/docs/
Would it be tricky to adjust your work to mirror the existing
structure for existing docs? I'm not even too fussy about not
breaking the links in /docs/current/ but all of the existing pages
such as /docs/1.7.7/ should be maintained if possible!
There's so many good suggestions here for future work and improving
our message and communication, I created
https://issues.apache.org/jira/browse/AVRO-3264 to point to this
discussion after we get this up.
Thanks again for your great work!
Ryan
On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
>
> I speak only for myself, but I am working in an environment where I am regularly checking docs all the way back to 1.8.x because we have legacy systems we cannot upgrade, and I am often referencing rules about schema canonical form. I value a lot the sidebar bottom version switching navigation from sites such as here https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take ... but I know it can be extraordinarily difficult to make it work correctly with these static site generators.
>
> Lee Hambley
> http://lee.hambley.name/
> +49 (0) 170 298 5667
>
>
> On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org> wrote:
>>
>>
>>
>> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
>>>
>>> Wow this is pretty neat ! Nice job Martin! A modern website can
>>> encourage more contributions.
>>> I am more interested on content than aesthetics first. Is everything
>>> already migrated? Anything missing? Any issue to report?
>>
>>
>> Everything is migrated for the documentation of the *current* version.
>> The old site contains documentation for both current and current-1. Is this something you would like to preserve ?
>>
>>>
>>>
>>>
>>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org> wrote:
>>> >
>>> > Hi,
>>> >
>>> > Anyone willing to send a PR with the suggested improvement?
>>> > Or at least open an issue with the well formulated text and I will add it!
>>> >
>>> > Regards,
>>> > Martin
>>> >
>>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <os...@westravanholthe.nl> wrote:
>>> >>
>>> >> Hi,
>>> >>
>>> >> This is a huge improvement. Responsive, excellent navigation, syntax
>>> >> highlighting, ...
>>> >>
>>> >> The only downside I see was already mentioned by Lee: the landing page is
>>> >> too empty (also in a mobile browser).
>>> >> I think we could really benefit from mentioning the unique selling point of
>>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
>>> >> availability & excellent schema evolution.
>>> >>
>>> >> Kind regards,
>>> >> Oscar
>>> >>
>>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org> wrote:
>>> >>
>>> >> > Hi all,
>>> >> >
>>> >> > Please check the new candidate for Apache Avro website:
>>> >> > https://avro-website.netlify.app/
>>> >> >
>>> >> > It is based on Hugo and uses Docsy theme.
>>> >> > Its source code and instructions how to build could be found at
>>> >> > https://github.com/martin-g/avro-website.
>>> >> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>>> >> >
>>> >> > I am not web designer, so some things may look not finished.
>>> >> > I've just copied the HTML content from the old site (
>>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>>> >> >
>>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>>> >> >
>>> >> > Regards,
>>> >> > Martin
>>> >> >
Re: New website
Posted by Ryan Skraba <ry...@skraba.com>.
Hello!
I realized that I haven't commented on this mailing list thread -- I
made some comments on https://issues.apache.org/jira/browse/AVRO-2175
This looks amazing and we should merge it very soon :D It's not
perfect, but it's really a great improvement and definitely not worst
than the existing website!
I've been taking a look at what we need to use the existing
infrastructure, and there's interesting links at:
- https://infra.apache.org/release-download-pages.html
- https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
- https://infra.apache.org/website-guidelines.html
- https://infra.apache.org/project-site.html
I like that Beam has the website in the main repo, but notably the
INFRA recommendation is that we use a separate repo for the website
(named `avro-site` though). Any thoughts? It's always something we
can try and change later! Would it make it easier for the javadoc and
other languages if they were in the same repo, or does it make little
difference?
The old site actually contains all of the documentation for EVERY
release, which can be found here:
- https://svn.apache.org/repos/asf/avro/site/publish/docs/
- https://avro.apache.org/docs/
Would it be tricky to adjust your work to mirror the existing
structure for existing docs? I'm not even too fussy about not
breaking the links in /docs/current/ but all of the existing pages
such as /docs/1.7.7/ should be maintained if possible!
There's so many good suggestions here for future work and improving
our message and communication, I created
https://issues.apache.org/jira/browse/AVRO-3264 to point to this
discussion after we get this up.
Thanks again for your great work!
Ryan
On Thu, Nov 4, 2021 at 4:26 PM Lee Hambley <le...@gmail.com> wrote:
>
> I speak only for myself, but I am working in an environment where I am regularly checking docs all the way back to 1.8.x because we have legacy systems we cannot upgrade, and I am often referencing rules about schema canonical form. I value a lot the sidebar bottom version switching navigation from sites such as here https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take ... but I know it can be extraordinarily difficult to make it work correctly with these static site generators.
>
> Lee Hambley
> http://lee.hambley.name/
> +49 (0) 170 298 5667
>
>
> On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org> wrote:
>>
>>
>>
>> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
>>>
>>> Wow this is pretty neat ! Nice job Martin! A modern website can
>>> encourage more contributions.
>>> I am more interested on content than aesthetics first. Is everything
>>> already migrated? Anything missing? Any issue to report?
>>
>>
>> Everything is migrated for the documentation of the *current* version.
>> The old site contains documentation for both current and current-1. Is this something you would like to preserve ?
>>
>>>
>>>
>>>
>>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org> wrote:
>>> >
>>> > Hi,
>>> >
>>> > Anyone willing to send a PR with the suggested improvement?
>>> > Or at least open an issue with the well formulated text and I will add it!
>>> >
>>> > Regards,
>>> > Martin
>>> >
>>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <os...@westravanholthe.nl> wrote:
>>> >>
>>> >> Hi,
>>> >>
>>> >> This is a huge improvement. Responsive, excellent navigation, syntax
>>> >> highlighting, ...
>>> >>
>>> >> The only downside I see was already mentioned by Lee: the landing page is
>>> >> too empty (also in a mobile browser).
>>> >> I think we could really benefit from mentioning the unique selling point of
>>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
>>> >> availability & excellent schema evolution.
>>> >>
>>> >> Kind regards,
>>> >> Oscar
>>> >>
>>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org> wrote:
>>> >>
>>> >> > Hi all,
>>> >> >
>>> >> > Please check the new candidate for Apache Avro website:
>>> >> > https://avro-website.netlify.app/
>>> >> >
>>> >> > It is based on Hugo and uses Docsy theme.
>>> >> > Its source code and instructions how to build could be found at
>>> >> > https://github.com/martin-g/avro-website.
>>> >> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>>> >> >
>>> >> > I am not web designer, so some things may look not finished.
>>> >> > I've just copied the HTML content from the old site (
>>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>>> >> >
>>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>>> >> >
>>> >> > Regards,
>>> >> > Martin
>>> >> >
Re: New website
Posted by Lee Hambley <le...@gmail.com>.
I speak only for myself, but I am working in an environment where I am
regularly checking docs all the way back to 1.8.x because we have legacy
systems we cannot upgrade, and I am often referencing rules about schema
canonical form. I value a lot the sidebar bottom version switching
navigation from sites such as here
https://fastavro.readthedocs.io/en/latest/writer.html#using-the-record-hint-to-specify-which-branch-of-a-union-to-take
... but I know it can be extraordinarily difficult to make it work
correctly with these static site generators.
Lee Hambley
http://lee.hambley.name/
+49 (0) 170 298 5667
On Thu, 4 Nov 2021 at 16:23, Martin Grigorov <mg...@apache.org> wrote:
>
>
> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
>
>> Wow this is pretty neat ! Nice job Martin! A modern website can
>> encourage more contributions.
>> I am more interested on content than aesthetics first. Is everything
>> already migrated? Anything missing? Any issue to report?
>>
>
> Everything is migrated for the documentation of the *current* version.
> The old site contains documentation for both current and current-1. Is
> this something you would like to preserve ?
>
>
>>
>>
>> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
>> wrote:
>> >
>> > Hi,
>> >
>> > Anyone willing to send a PR with the suggested improvement?
>> > Or at least open an issue with the well formulated text and I will add
>> it!
>> >
>> > Regards,
>> > Martin
>> >
>> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
>> oscar@westravanholthe.nl> wrote:
>> >>
>> >> Hi,
>> >>
>> >> This is a huge improvement. Responsive, excellent navigation, syntax
>> >> highlighting, ...
>> >>
>> >> The only downside I see was already mentioned by Lee: the landing page
>> is
>> >> too empty (also in a mobile browser).
>> >> I think we could really benefit from mentioning the unique selling
>> point of
>> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
>> language
>> >> availability & excellent schema evolution.
>> >>
>> >> Kind regards,
>> >> Oscar
>> >>
>> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
>> wrote:
>> >>
>> >> > Hi all,
>> >> >
>> >> > Please check the new candidate for Apache Avro website:
>> >> > https://avro-website.netlify.app/
>> >> >
>> >> > It is based on Hugo and uses Docsy theme.
>> >> > Its source code and instructions how to build could be found at
>> >> > https://github.com/martin-g/avro-website.
>> >> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>> >> >
>> >> > I am not web designer, so some things may look not finished.
>> >> > I've just copied the HTML content from the old site (
>> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>> >> >
>> >> > Any feedback is welcome! With Pull Requests would be awesome!
>> >> >
>> >> > Regards,
>> >> > Martin
>> >> >
>>
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
> Wow this is pretty neat ! Nice job Martin! A modern website can
> encourage more contributions.
> I am more interested on content than aesthetics first. Is everything
> already migrated? Anything missing? Any issue to report?
>
Everything is migrated for the documentation of the *current* version.
The old site contains documentation for both current and current-1. Is this
something you would like to preserve ?
>
>
> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
> wrote:
> >
> > Hi,
> >
> > Anyone willing to send a PR with the suggested improvement?
> > Or at least open an issue with the well formulated text and I will add
> it!
> >
> > Regards,
> > Martin
> >
> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> oscar@westravanholthe.nl> wrote:
> >>
> >> Hi,
> >>
> >> This is a huge improvement. Responsive, excellent navigation, syntax
> >> highlighting, ...
> >>
> >> The only downside I see was already mentioned by Lee: the landing page
> is
> >> too empty (also in a mobile browser).
> >> I think we could really benefit from mentioning the unique selling
> point of
> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> language
> >> availability & excellent schema evolution.
> >>
> >> Kind regards,
> >> Oscar
> >>
> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
> >>
> >> > Hi all,
> >> >
> >> > Please check the new candidate for Apache Avro website:
> >> > https://avro-website.netlify.app/
> >> >
> >> > It is based on Hugo and uses Docsy theme.
> >> > Its source code and instructions how to build could be found at
> >> > https://github.com/martin-g/avro-website.
> >> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
> >> >
> >> > I am not web designer, so some things may look not finished.
> >> > I've just copied the HTML content from the old site (
> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >> >
> >> > Any feedback is welcome! With Pull Requests would be awesome!
> >> >
> >> > Regards,
> >> > Martin
> >> >
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ie...@gmail.com> wrote:
> Wow this is pretty neat ! Nice job Martin! A modern website can
> encourage more contributions.
> I am more interested on content than aesthetics first. Is everything
> already migrated? Anything missing? Any issue to report?
>
Everything is migrated for the documentation of the *current* version.
The old site contains documentation for both current and current-1. Is this
something you would like to preserve ?
>
>
> On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org>
> wrote:
> >
> > Hi,
> >
> > Anyone willing to send a PR with the suggested improvement?
> > Or at least open an issue with the well formulated text and I will add
> it!
> >
> > Regards,
> > Martin
> >
> > On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
> oscar@westravanholthe.nl> wrote:
> >>
> >> Hi,
> >>
> >> This is a huge improvement. Responsive, excellent navigation, syntax
> >> highlighting, ...
> >>
> >> The only downside I see was already mentioned by Lee: the landing page
> is
> >> too empty (also in a mobile browser).
> >> I think we could really benefit from mentioning the unique selling
> point of
> >> Avro here: "Your Data. Any Time, Anywhere." And then mention the
> language
> >> availability & excellent schema evolution.
> >>
> >> Kind regards,
> >> Oscar
> >>
> >> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
> >>
> >> > Hi all,
> >> >
> >> > Please check the new candidate for Apache Avro website:
> >> > https://avro-website.netlify.app/
> >> >
> >> > It is based on Hugo and uses Docsy theme.
> >> > Its source code and instructions how to build could be found at
> >> > https://github.com/martin-g/avro-website.
> >> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
> >> >
> >> > I am not web designer, so some things may look not finished.
> >> > I've just copied the HTML content from the old site (
> >> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >> >
> >> > Any feedback is welcome! With Pull Requests would be awesome!
> >> >
> >> > Regards,
> >> > Martin
> >> >
>
Re: New website
Posted by Ismaël Mejía <ie...@gmail.com>.
Wow this is pretty neat ! Nice job Martin! A modern website can
encourage more contributions.
I am more interested on content than aesthetics first. Is everything
already migrated? Anything missing? Any issue to report?
On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org> wrote:
>
> Hi,
>
> Anyone willing to send a PR with the suggested improvement?
> Or at least open an issue with the well formulated text and I will add it!
>
> Regards,
> Martin
>
> On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <os...@westravanholthe.nl> wrote:
>>
>> Hi,
>>
>> This is a huge improvement. Responsive, excellent navigation, syntax
>> highlighting, ...
>>
>> The only downside I see was already mentioned by Lee: the landing page is
>> too empty (also in a mobile browser).
>> I think we could really benefit from mentioning the unique selling point of
>> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
>> availability & excellent schema evolution.
>>
>> Kind regards,
>> Oscar
>>
>> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org> wrote:
>>
>> > Hi all,
>> >
>> > Please check the new candidate for Apache Avro website:
>> > https://avro-website.netlify.app/
>> >
>> > It is based on Hugo and uses Docsy theme.
>> > Its source code and instructions how to build could be found at
>> > https://github.com/martin-g/avro-website.
>> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>> >
>> > I am not web designer, so some things may look not finished.
>> > I've just copied the HTML content from the old site (
>> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>> >
>> > Any feedback is welcome! With Pull Requests would be awesome!
>> >
>> > Regards,
>> > Martin
>> >
Re: New website
Posted by Ismaël Mejía <ie...@gmail.com>.
Wow this is pretty neat ! Nice job Martin! A modern website can
encourage more contributions.
I am more interested on content than aesthetics first. Is everything
already migrated? Anything missing? Any issue to report?
On Tue, Nov 2, 2021 at 7:01 PM Martin Grigorov <mg...@apache.org> wrote:
>
> Hi,
>
> Anyone willing to send a PR with the suggested improvement?
> Or at least open an issue with the well formulated text and I will add it!
>
> Regards,
> Martin
>
> On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <os...@westravanholthe.nl> wrote:
>>
>> Hi,
>>
>> This is a huge improvement. Responsive, excellent navigation, syntax
>> highlighting, ...
>>
>> The only downside I see was already mentioned by Lee: the landing page is
>> too empty (also in a mobile browser).
>> I think we could really benefit from mentioning the unique selling point of
>> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
>> availability & excellent schema evolution.
>>
>> Kind regards,
>> Oscar
>>
>> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org> wrote:
>>
>> > Hi all,
>> >
>> > Please check the new candidate for Apache Avro website:
>> > https://avro-website.netlify.app/
>> >
>> > It is based on Hugo and uses Docsy theme.
>> > Its source code and instructions how to build could be found at
>> > https://github.com/martin-g/avro-website.
>> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
>> >
>> > I am not web designer, so some things may look not finished.
>> > I've just copied the HTML content from the old site (
>> > https://avro.apache.org/) and converted it to Markdown for Hugo.
>> >
>> > Any feedback is welcome! With Pull Requests would be awesome!
>> >
>> > Regards,
>> > Martin
>> >
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi,
Anyone willing to send a PR with the suggested improvement?
Or at least open an issue with the well formulated text and I will add it!
Regards,
Martin
On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
oscar@westravanholthe.nl> wrote:
> Hi,
>
> This is a huge improvement. Responsive, excellent navigation, syntax
> highlighting, ...
>
> The only downside I see was already mentioned by Lee: the landing page is
> too empty (also in a mobile browser).
> I think we could really benefit from mentioning the unique selling point of
> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
> availability & excellent schema evolution.
>
> Kind regards,
> Oscar
>
> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
>
> > Hi all,
> >
> > Please check the new candidate for Apache Avro website:
> > https://avro-website.netlify.app/
> >
> > It is based on Hugo and uses Docsy theme.
> > Its source code and instructions how to build could be found at
> > https://github.com/martin-g/avro-website.
> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
> >
> > I am not web designer, so some things may look not finished.
> > I've just copied the HTML content from the old site (
> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >
> > Any feedback is welcome! With Pull Requests would be awesome!
> >
> > Regards,
> > Martin
> >
>
Re: New website
Posted by Martin Grigorov <mg...@apache.org>.
Hi,
Anyone willing to send a PR with the suggested improvement?
Or at least open an issue with the well formulated text and I will add it!
Regards,
Martin
On Tue, Nov 2, 2021, 18:08 Oscar Westra van Holthe - Kind <
oscar@westravanholthe.nl> wrote:
> Hi,
>
> This is a huge improvement. Responsive, excellent navigation, syntax
> highlighting, ...
>
> The only downside I see was already mentioned by Lee: the landing page is
> too empty (also in a mobile browser).
> I think we could really benefit from mentioning the unique selling point of
> Avro here: "Your Data. Any Time, Anywhere." And then mention the language
> availability & excellent schema evolution.
>
> Kind regards,
> Oscar
>
> On Thu, 28 Oct 2021 at 10:43, Martin Grigorov <mg...@apache.org>
> wrote:
>
> > Hi all,
> >
> > Please check the new candidate for Apache Avro website:
> > https://avro-website.netlify.app/
> >
> > It is based on Hugo and uses Docsy theme.
> > Its source code and instructions how to build could be found at
> > https://github.com/martin-g/avro-website.
> > The JIRA ticket is: https://issues.apache.org/jira/browse/AVRO-2175
> >
> > I am not web designer, so some things may look not finished.
> > I've just copied the HTML content from the old site (
> > https://avro.apache.org/) and converted it to Markdown for Hugo.
> >
> > Any feedback is welcome! With Pull Requests would be awesome!
> >
> > Regards,
> > Martin
> >
>