You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/01/19 17:33:11 UTC
[arrow-cookbook] 01/01: Fix Markdown/Jira-style links in README
This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch lidavidm-patch-1
in repository https://gitbox.apache.org/repos/asf/arrow-cookbook.git
commit 57e727fa8152ef2242cacd0446e83ea41b272c40
Author: David Li <li...@gmail.com>
AuthorDate: Wed Jan 19 12:33:03 2022 -0500
Fix Markdown/Jira-style links in README
---
README.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.rst b/README.rst
index a71f032..22d620e 100644
--- a/README.rst
+++ b/README.rst
@@ -6,12 +6,12 @@ that Arrow users might want to do. The cookbook is actually
composed of multiple cookbooks, one for each supported platform,
which contain the recipes for that specific platform.
-The cookbook aims to provide immediate instructions for common tasks, in
-contrast with the [Arrow User Guides](https://arrow.apache.org/docs/index.html)
-which provides in-depth explanation. In terms of the
-[Diátaxis framework|https://diataxis.fr/], the cookbook is *task-oriented*
-while the user guide is *learning-oriented*. The cookbook will often refer to
-the user guide for deeper explanation.
+The cookbook aims to provide immediate instructions for common tasks, in
+contrast with the `Arrow User Guides <https://arrow.apache.org/docs/index.html>`_
+which provides in-depth explanation. In terms of the `Diátaxis framework
+<https://diataxis.fr/>`_, the cookbook is *task-oriented* while the user guide
+is *learning-oriented*. The cookbook will often refer to the user guide for
+deeper explanation.
All cookbooks are buildable to HTML and verifiable by running
a set of tests that confirm that the recipes are still working