thisisnic commented on a change in pull request #11677: URL: https://github.com/apache/arrow/pull/11677#discussion_r758327180
########## File path: docs/source/developers/guide/introduction.rst ########## @@ -0,0 +1,154 @@ +.. 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. + + +.. SCOPE OF THIS SECTION +.. Make an introduction to the Guide for New Contributors. +.. Add an introduction to the project, why to get involved +.. and a quick checklist of the contributing process. +.. Add the Table of Contents. All detailed explanations +.. should be added as a link in the content. + + +.. _introduction: + +*********************** +New Contributor's Guide +*********************** + +This guide is meant to be a resource for contributing to +`Arrow <https://arrow.apache.org>`_ for new contributors. + +No matter what your current skills are you can try and make +your first time contribution to Arrow. + +Starting to contribute to a project like Apache Arrow can be +intimidating. Taking small steps will help making this tack +easier. + + +Why contribute to Arrow? +======================== +There can be various reasons why someone would want to contribute +to Arrow: + +* You find the project interesting and would like to try making + a contribution to learn more about the library and grow your skills. + +* You use Arrow in the project you are working on and you would like Review comment: ```suggestion * You use Arrow in a project you are working on and you would like ``` ########## File path: docs/source/developers/guide/other.rst ########## @@ -0,0 +1,29 @@ +.. 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. + + +.. SCOPE OF THIS SECTION +.. Add articles/resources on concepts important to Arrow as +.. well as recommended books for learning different languages +.. included in the project. + + +.. _other: + +***************************** +Additional info and resources Review comment: ```suggestion Additional information and resources ``` ########## File path: docs/source/developers/guide/architectural_overview.rst ########## @@ -0,0 +1,40 @@ +.. 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. + + +.. SCOPE OF THIS SECTION +.. This section should include architectural overview +.. of the Arrow project. If possible the content should be +.. written in words easy understandable to beginner not +.. necessary acquainted with the library and the technical +.. details. + +.. _architectural_overview: + +********************** +Architectural Overview +********************** + +A general overview of Apache Arrow project can be found on the +`front page <https://arrow.apache.org/>`_ and in the +`Apache Arrow Overview <https://arrow.apache.org/overview/>`_. + +For an Architectural Overview of Arrow's libraries please +refer to: + +- PyArrow Architectural Overview +- R-Arrow Architectural Overview Review comment: ```suggestion - R package Architectural Overview ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
