I am +1 on the idea of using some sort of Wiki (either Github or Apache confluence cwiki) for design discussions and related docs. A wiki is so much easier to update information quickly rather than trying to use SVN or the website repo and when working on design changes as document updates can happen pretty quickly when collaborating. It's also super easier to view the edit history, etc.
In terms of the web site, I've always viewed a project's website as more customer facing than for core project developers. Obviously the website can host whatever we want but in my opinion I think a website is best served as a place that gives information about the project, official documentation, news/updates, contact information, etc. which is what most projects (not just Apache) do. We can always have a link on the website for the wiki for development. If there is a concern about github wiki not being backed up then as Dave mentioned I think the Apache wiki is a good alternative. For example, Kafka hosts all of their design proposals and discussion on Cwiki: https://cwiki.apache.org/confluence/display/kafka/kafka+improvement+proposals which makes it easier to track history and edit quickly. On Sat, Feb 25, 2023 at 7:55 AM <dlmar...@comcast.net> wrote: > > I reverted the change. I didn't think it would be a big deal, but if it > requires discussion, then let's discuss it. > > I'm looking for a place to host information related to internal design > discussions. I envision these to be living documents that will be updated > over time as the design/implementation progresses and that other committers > will be able to comment on and edit. I don't feel that the website is the > correct place for this because: > > 1. I don't think internal design discussions should go on the project > website. > 2. Changes to the design documents could not be seen by others right away > (IIRC changes to the website are built and available at > https://accumulo.staged.apache.org/, but human intervention is required to > publish it at https://accumulo.apache.org/). > > I looked in the INFRA issues and other projects are using the GH Wiki feature > and I saw no mention of backing it up or the requirement to do so (maybe they > rely on GitHub backing it up?). It does appear that we would need an INFRA > ticket so that they can modify the GitHub project settings to lock the GitHub > wiki down so that only committers can modify it. If GitHub Wiki is not > acceptable, then I think Apache Confluence (https://cwiki.apache.org) might > be an acceptable alternative. > > -----Original Message----- > From: Christopher <ctubb...@apache.org> > Sent: Saturday, February 25, 2023 4:41 AM > To: accumulo-dev <dev@accumulo.apache.org> > Cc: comm...@accumulo.apache.org > Subject: Re: [accumulo] branch main updated: Enable Github wiki in asf.yaml > > I don't recall a discussion about this change, but I think it goes against > previous efforts to make the website the one canonical location for our > documentation. I don't even think infra is backing up wiki repos, so there > wouldn't even be a record of the wiki contents in ASF spaces (vs. the main > repo, which is backed up to GitBox and the issue tracker, which CCs the > notifications list). > > In short, I think this should be reverted and we should not use the GitHub > wiki. If we need to store documents in a version controlled way, we can store > them on the website, or in our project's SVN dev space. The wiki is just > another place people would have to follow if they want to participate, and I > don't think that serves us. Therefore, I think we shouldn't use it. > > > On Fri, Feb 24, 2023, 15:59 <dlmar...@apache.org> wrote: > > > This is an automated email from the ASF dual-hosted git repository. > > > > dlmarion pushed a commit to branch main in repository > > https://gitbox.apache.org/repos/asf/accumulo.git > > > > > > The following commit(s) were added to refs/heads/main by this push: > > new ae8a817e7b Enable Github wiki in asf.yaml ae8a817e7b is > > described below > > > > commit ae8a817e7b2af8c64096ed1a4274eaef44c0e677 > > Author: Dave Marion <dlmar...@apache.org> > > AuthorDate: Fri Feb 24 15:59:10 2023 -0500 > > > > Enable Github wiki in asf.yaml > > --- > > .asf.yaml | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/.asf.yaml b/.asf.yaml > > index bc2c943e82..08aa357082 100644 > > --- a/.asf.yaml > > +++ b/.asf.yaml > > @@ -27,7 +27,7 @@ github: > > - big-data > > - hacktoberfest > > features: > > - wiki: false > > + wiki: true > > issues: true > > projects: true > > > > > > >
