Hi, Here is a PR [1] that introduces a new Github Actions workflow that could update the website whenever something is changed in the doc/ folder. Feedback is welcome!
1. https://github.com/apache/avro/pull/2187 On Tue, Apr 4, 2023 at 4:44 PM Ryan Skraba <[email protected]> wrote: > Hey William Taylor, thanks for bringing these up -- we're in an odd > state right now with the website where we have to manually release it > (during an Avro release), but ... it's a complicated process likely to > change! > > Thankfully, Martin has been working towards having auto-deployed > artifacts and (crossing fingers) hopefully we can end up in a state > where fixing a doc is as simple as editing the page on GitHub. We > aren't quite there yet. > > Please don't hesitate to continue bringing questions to the group, and > if you're interested in contributing, we can create a JIRA account for > you (see https://selfserve.apache.org/jira-account.html) or you can > create PRs on the documentation pages directly in the wiki. > > Thanks Martin for the pointers to where the pages exist in the repo > (at time of writing...) > > All my best, Ryan > > On Tue, Apr 4, 2023 at 2:46 PM Martin Grigorov <[email protected]> > wrote: > > > > Hi, > > > > On Tue, Apr 4, 2023 at 2:49 PM William Taylor < > [email protected]> > > wrote: > > > > > Dear Avro Developers, > > > > > > While doing some research as part of my employment, I noticed a couple > of > > > issues about your website. I'm not sure if the dev mailing list is the > > > right place for issues with the website, but if not, I would > appreciate it > > > if you could point me in the right direction. > > > > > > Mainly, I saw that on > > > https://avro.apache.org/docs/1.11.1/getting-started-python/ it has on > the > > > schema: > > > > > > {"name": "favorite_color", "type": ["string", "null"]} > > > > > > But further down it says "Since the field favorite_color has type > ["int", > > > "null"], ...". The code snipped that sentence relates to seems to make > > > sense, it's just the explanation that seems mistaken. > > > > > > > This has been fixed at Nov 4 2022 with > > > https://github.com/apache/avro/commit/1834742813715a8d30aa38194481437174ed7776 > > but there was no new release of Avro and thus no new site update since > then. > > > > > > > > > > I also noticed that the code snippet formatted like so in the v1.11.0 > docs: > > > [image: image.png] > > > is not formatted properly in the v1.11.1 docs (which I notice have a > > > generally different style, so this is probably just a transitionary > issue): > > > [image: image.png] > > > > > > > Your images didn't make it but I guess you talk about > > > https://github.com/apache/avro/commit/4359e1915d615ede3203f0b7479ea041b28b6cb2 > > > > > > > > > > Finally, I saw that the link to the contribution guides ( > > > https://avro.apache.org/docs/contribution-guidelines/) which appears > at > > > the bottom of the community page (https://avro.apache.org/community/) > > > 404s - which is why I thought of directing this information here. > > > > > > > I guess this is also something that has been already fixed because I > cannot > > find contribution-guidelines in community - > > > https://raw.githubusercontent.com/apache/avro/master/doc/content/en/community/_index.md > > The docs are here - > > > https://github.com/apache/avro/blob/master/doc/content/en/project/How%20to%20contribute/_index.md > > > > > > > > > > > > Thanks for the software! > > > > > > Kind regards, > > > William Taylor > > > >
