Replies: 5 comments
-
|
Yeah I agree that's the direction. |
Beta Was this translation helpful? Give feedback.
-
|
I don't have particular preference for any. |
Beta Was this translation helpful? Give feedback.
-
|
I agree with looking at how other Apache projects handle documentation. I prefer that everything be on the website, with only the simple setup documentation included in the main README. |
Beta Was this translation helpful? Give feedback.
-
|
I think moving long-term user documentation from the wiki to site https://texera.apache.org/docs/ would be consistent with how many Apache projects manage documentation today. I looked at several Apache projects, especially larger and more mature ones, and the pattern seems fairly consistent: the website/docs site is usually treated as the primary place for user-facing documentation, while the wiki is often no longer used for that purpose and instead mainly serves as a pointer to the website. For the relatively small number of projects that still maintain wiki pages, those pages are more commonly used for proposals, contributor or development process, meeting notes, or historical and archival material. Based on this, I think it would make sense for us to gradually move user-facing wiki pages to the docs site over time. |
Beta Was this translation helpful? Give feedback.
-
|
Sounds good. That will be the plan. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Currently we have a lot of documentation is on the site https://github.com/apache/texera/wiki. Another place is to use the Apache site https://texera.apache.org/docs/ . For the long term, I believe we should move the content from the former to the latter.
@Ma77Ball @carloea2 @aglinxinyuan @xuang7 @Yicong-Huang and everybody, thoughts?
@xuang7 Please do some research about other Apache projects and show how others manage their documentation.
Beta Was this translation helpful? Give feedback.
All reactions