On Mon, Dec 13, 2021 at 9:38 AM Martin Grigorov <mgrigo...@apache.org> wrote:
> Hi Ryan, > > On Sun, Dec 12, 2021 at 1:36 PM Ryan Skraba <r...@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.hamb...@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 <mgrigo...@apache.org> >> wrote: >> >> >> >> >> >> >> >> On Thu, Nov 4, 2021 at 5:04 PM Ismaël Mejía <ieme...@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 <mgrigo...@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 < >> mgrigo...@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 >> >>> >> > >> >
