AVRO-3264: Improvements to the project section of the Avro website #2145
Conversation
nishchaldv
changed the title
nishchaldv
changed the title
RyanSkraba
left a comment
RyanSkraba
left a comment
There was a problem hiding this comment.
Hey, thanks for the contribution -- and my excuses for taking a while to review and merge this! I'm having an issue with the build process when we have more than one release. For the moment, 1.11.1 is the only Avro release that actually has the hugo-generated pages.
@martin-g has been looking at being able to automatically deploy the project pages, and I've been looking at how we can possibly deploy the release pages independently from project pages... I'm not sure when we can actually get your changes reflected on the Avro website, but I'm glad to have them captured in the repository now!
|
I can revive my work on the automatic website deployment. apache/datafusion#5670 - here is a PR that I just finished for Apache Arrow Datafusion. |
|
I think it gets worse than separate SDKs! I don't see how we can have automatic deployment of some of the pages (which are "release" pages), as opposed to project pages... The spec, for example, is associated with a release (as are the JavaDocs, other API docs and examples). If you can get the project pages auto-deployed, however, we can worry about those other pages. I'm currently testing how we can separate them by copying how Flink does a separate nightlies page per-branch. (I like to copy whatever a bigger project does..!) |
|
Also if you can get your auto-deploy to work, we can restore the "Edit this page" buttons! \o/ |
|
Thank you, @RyanSkraba and @martin-g, for reviewing my work. |
3 participants
What is the purpose of the change
This pull request improves the Avro website's project section fixing AVRO-3264.
Verifying this change
This change is a trivial rework without any test coverage.
Documentation
This pull request improves the Avro website's project section in several ways. First, it adds papers and articles that can help users better understand Avro. Second, it includes onboarding guidelines for committers, contributors, and PMC members, which can assist them in understanding their workflows. Finally, it improves the 'How to Contribute' page by providing explanations on how to make code changes by cloning the project locally and running the avro-website inside a Docker container.
No