tengqm commented on PR #6659: URL: https://github.com/apache/gravitino/pull/6659#issuecomment-2724736100
> Hi @tengqm Thanks a lot for your work, greatly appreciated. > > I think we'd better avoid heavily rewriting the doc content as the starting point, my concern is that heavily rewriting may introduce some understanding errors, or miss some useful information. > > Instead, I would suggest we focus on the overall structure of the doc, how to reorganize to make the docs easy for user to find useful information he wanted, how to reorganize to make sure some related concepts can be linked between each other (currently they're splitting into different docs). Yes. Restructuring was my intent as well. This page is not long, but it took me more than 4 hours to finish refactor/restructure it. I need to first understand what are the steps to build gravitino, under what condition. For each paragraph or bulletin item, I struggled to find a right place for it. For example, in the original page, there was a huge "info" section at the start of the page. It repeats the same requirement about JDK, while mixing requirement to build Trino Connector in the same item. It talks about docker related tests and even OrbStack, but those are only relevant to the docker tests. It has a section dedicated to Windows environment, but the installation of `docker-ce` or Python are structured as a subsection for Windows box ... although it is a common step for all systems. For Windows, the only thing that is special is about WSL. Everything else are the same. I am not an English native speaker, and I am not a professional tech writer. I was only trying to make things more straightforward, easy for users to follow. If there are something we can clarify using one sentence, don't write two sentences. Anyway ... I have already got strong objections on line wrappings. Am I supposed to close this one? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@gravitino.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
