Proposal: Deprecate Google Docs for Design Docs #8284
kerneltime
started this conversation in
Ideas
Replies: 2 comments
-
Link to the discussion on the email list https://lists.apache.org/thread/w67ttxtvk0olv7732fsg1qrfgczrm0tb |
Beta Was this translation helpful? Give feedback.
0 replies
-
https://ozone.apache.org/docs/edge/design/ozone-enhancement-proposals.html |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
We should shift our design discussions from Google Docs to Markdown files managed through GitHub Pull Requests. This approach would:
This shift aligns with open-source best practices and would reduce context switching between platforms. Also, Google Docs do not show up in Google searches and tend to get lost into obscurity. Without going into details, I am also not sure if they can be preserved for the duration of the project (vs a Git commit).
Thus, if we accept this proposal any Jira with a Google Doc attached for design would be requested to open a PR for the Jira with the design doc.
We could use Jira, but its interface is not suitable for large texts compared to the rich ecosystem around Markdown for authoring documents. Most IDEs have excellent Markdown integration.
We can draw images in our favorite editor and attach them to a markdown (or use ASCII art). LLMs are also very capable of authoring good ASCII diagrams or flow charts.
Ref:
#6121
Beta Was this translation helpful? Give feedback.
All reactions