5032901dfc
### _Why are the changes needed?_ Guidelines for Document and Code Contributions. - code style - documentation style - quick starts - sphinx-copybutton for copy button in code blocks - add kind:minor,help wanted,good first issue to doc issue template ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png"> - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4768 from yaooqinn/guide. Closes #4768 3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst 8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst a753bdde5 [Kent Yao] Guidelines for Document and Code contributions f8393fe8d [Kent Yao] Guidelines for Document and Code contributions 8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions 4f3a2128b [Kent Yao] Guidelines for Document and Code contributions Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
44 lines
1.8 KiB
ReStructuredText
44 lines
1.8 KiB
ReStructuredText
.. Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
.. Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
Contributing Documentations
|
|
===========================
|
|
|
|
The project documentation is crucial for users and contributors. This guide
|
|
outlines the contribution guidelines for Apache Kyuubi documentation.
|
|
|
|
Kyuubi's documentation source files are maintained in the same `github repository`_
|
|
as the code base, which ensures updating code and documentation synchronously.
|
|
All documentation source files can be found in the sub-folder named ``docs``.
|
|
|
|
Kyuubi's documentation is published and hosted on `Read The Docs`_ platform by
|
|
version. with each version having its own dedicated page. To access a specific
|
|
version of the document, simply navigate to the "Docs" tab on our Home Page.
|
|
|
|
We welcome any contributions to the documentation, including but not limited to
|
|
writing, translation, report doc issues on Github, reposting.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
get_started
|
|
style
|
|
build
|
|
|
|
.. _Github repository: https://github.com/apache/kyuubi
|
|
.. _Restructured Text: https://en.wikipedia.org/wiki/ReStructuredText
|
|
.. _Read The Docs: https://kyuubi.rtfd.io
|
|
.. _Home Page: https://kyuubi.apache.org |