TBH i find the wiki to be entirely unfriendly. It hard to find things in it and isn't discoverable. The syntax is archaic and the UI is wonky. There's no "flow" to it. No common entry point etc.
I'd rather the release guide remain in Github as markdown, even if it's not on the website anymore. This also keeps contributor documentation where contributors are actually working. Also, the lack of review for wiki changes is convenient for tiny typos but honestly I'd prefer our documentation gets read by at least one other person when we commit to it. So I'm +1 to moving it, but -0 if it's to the wiki. On Thu, Sep 21, 2023, 9:58 AM Chamikara Jayalath via dev < dev@beam.apache.org> wrote: > I might be wrong but I think of wiki as a more volatile and a less > reliable place than the Website (can be updated without a review by any > committer and we do that quite often). I think things in the > contribution guide are key to a healthy Beam community so I'd like them to > be in a more stable place that gets reviewed appropriately when updated. > > Thanks, > Cham > > On Thu, Sep 21, 2023 at 9:14 AM Danny McCormick via dev < > dev@beam.apache.org> wrote: > >> +1 on moving the release guide. I'd argue that everything under the >> `contribute` tag other than the main page ( >> https://beam.apache.org/contribute/) and the link to CONTRIBUTING.md >> <https://github.com/apache/beam/blob/master/CONTRIBUTING.md> makes more >> sense on the wiki (we can keep the section with the sidebar links just >> redirecting to the wiki). I don't think it makes sense to move anything >> else, but the contributing section is inherently "dev focused". >> >> Thanks, >> Danny >> >> On Thu, Sep 21, 2023 at 11:58 AM Kenneth Knowles <k...@apache.org> wrote: >> >>> Hello! >>> >>> I am reviving a discussion that began at >>> https://lists.apache.org/thread/w4g8xpg4215nlq86hxbd6n3q7jfnylny when >>> we started our Confluence wiki and has even been revived once before. >>> >>> The conclusion of that thread was basically "yes, let us separate the >>> contributor-facing stuff to a different site". It also was the boot up of >>> the Confluence wiki but I want to not discuss tech/hosting for this thread. >>> I want to focus on the issue of having a separate user-facing website vs a >>> contributor-facing website. Some things like issue priorities are >>> user-and-dev facing and they require review for changes and should stay on >>> the user site. I also don't want to get into those more complex cases. >>> >>> We are basically in a halfway state today because I didn't have enough >>> volunteer time to finish everything and I did not wrangle enough help. >>> >>> So now I am release manager and encountering the docs more closely >>> again. The release docs really blend stuff. >>> >>> - The main release guide is on the website. >>> - Some steps, though, are GitHub Issues that we push along from release >>> Milestone to the next one. >>> - The actual technical bits to do the steps are sometimes on the >>> confluence wiki >>> - I expect I will also be touching README files in various folders of >>> the repo >>> >>> So I just want to make some more steps, and I wanted to ask the >>> community for their current thoughts. I think one big step could be to move >>> the release guide itself to the dev site, which is currently the wiki. >>> >>> What do you think? Are there any other areas of the website that you >>> think could just move to the wiki today? >>> >>> Kenn >>> >>> p.s. Some time in the past I saw an upper right corner fold (like >>> https://www.istockphoto.com/illustrations/paper-corner-fold) that took >>> you to the dev site that looked the same with different color scheme. That >>> was fun :-) >>> >>
