Re: design docs that get deleted, etc

2024-07-05 Thread Niel Markwick via dev
> google docs -> markdown converters https://workspace.google.com/marketplace/app/docs_to_markdown/700168918607 is a pretty good gdocs addon that converts to markdown There are some issues which may need some manual cleanup, but provided the Gdoc is relatively 'simple', it works well. --

Re: design docs that get deleted, etc

2024-06-03 Thread Kenneth Knowles
I like the idea of a "final" step of exporting the Google Doc to markdown and checking it in, if there is any tool that does an OK job (my experience with such tools over my lifetime has been underwhelming, but I'm always open to being pleasantly surprised). PDF would be a close second. Kenn On

Re: design docs that get deleted, etc

2024-05-30 Thread Jan Lukavský
Yes, I think that the discoverability and durability would be part of some "process". There could be "informal" part, where the design can take place virtually anywhere and the document can be owned by anyone (as we do today), then it would be copied to a durable store (asf wiki?) and a

Re: design docs that get deleted, etc

2024-05-29 Thread Robert Bradshaw via dev
On Wed, May 29, 2024 at 1:01 PM Robert Burke wrote: > > Honestly, it's less about how we propose things and more to do with actually > making "completing" the documentation work to some permanent place. > > That can be as simple as "migrate the final implemented design to a markdown > file in

Re: design docs that get deleted, etc

2024-05-29 Thread Robert Burke
Honestly, it's less about how we propose things and more to do with actually making "completing" the documentation work to some permanent place. That can be as simple as "migrate the final implemented design to a markdown file in the GitHub repo at *foo* or published on the beam website at *bar*.

Re: design docs that get deleted, etc

2024-05-29 Thread Robert Bradshaw via dev
While I'm not opposed to having a more formal process for proposals to go from idea to consensus to implementation, I'm not sure how much this would solve the primary issues we face (discoverability and durability). But maybe that could be built into the process? At the very least we could have an

Re: design docs that get deleted, etc

2024-05-29 Thread Jan Lukavský
Hi, regarding changing the way we document past (and more importantly future) changes, I've always been a big fan of the FLIP analogy [1]. I would love if we could make this work for Beam as well, while preserving the 'informal' part that I believe all of us want to keep. On the other hand,

design docs that get deleted, etc

2024-05-29 Thread Kenneth Knowles
Hi all, Yesterday someone asked me about the design doc linked from https://github.com/apache/beam/issues/18297 because it is now a 404. There are plenty of reasons a Google Doc might no longer be accessible. They exist outside the project's control. This is part of why ASF projects emphasize