Skip to content
Permalink
Browse files
Fix Markdown/Jira-style links in README (#128)
  • Loading branch information
lidavidm committed Jan 19, 2022
1 parent 20e874e commit ace13b6c22684ee84a2723d57581fc2b915fc458
Showing 1 changed file with 6 additions and 6 deletions.
@@ -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

0 comments on commit ace13b6

Please sign in to comment.