Skip to content

Commit

Permalink
ARROW-14441: [R] Add our philosophy to the dev vignette
Browse files Browse the repository at this point in the history
* separates some of the developer docs into separate files (content remains unchanged)
* updates the original dev docs page to point to these other pages and discuss our philosophy when implementing bindings

Closes #11705 from thisisnic/ARROW-14713_split_dev

Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Nic Crane <thisisnic@gmail.com>
  • Loading branch information
thisisnic committed Nov 23, 2021
1 parent 7a9738a commit e417fbf
Show file tree
Hide file tree
Showing 5 changed files with 700 additions and 680 deletions.
12 changes: 6 additions & 6 deletions dev/tasks/r/github.devdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ jobs:
DEVDOCS_UBUNTU: {{ "${{contains(matrix.os, 'ubuntu')}}" }}
DEVDOCS_WINDOWS: {{ "${{contains(matrix.os, 'windows')}}" }}
run: |
# This isn't actually rendering the docs, but will save arrow/r/vignettes/script.sh
# This isn't actually rendering the docs, but will save arrow/r/vignettes/developers/script.sh
# which can be sourced to install arrow.
rmarkdown::render("arrow/r/vignettes/developing.Rmd")
rmarkdown::render("arrow/r/vignettes/developers/setup.Rmd")
shell: Rscript {0}
- name: Install from the devdocs
env:
Expand All @@ -68,9 +68,9 @@ jobs:
# from Windows paths (C:\R\bin) to Unix paths (/c/r/bin)
echo export PATH=\"$(cygpath --path "$PATH")\" >> ~/.bash_profile
# This starts a special mingw64 Git Bash shell
$RTOOLS40_HOME/msys2_shell.cmd -here -mingw64 -no-start -defterm -full-path arrow/r/vignettes/script.sh
else
bash arrow/r/vignettes/script.sh
$RTOOLS40_HOME/msys2_shell.cmd -here -mingw64 -no-start -defterm -full-path arrow/r/vignettes/developers/script.sh
else
bash arrow/r/vignettes/developers/script.sh
fi
shell: bash
- name: Ensure that the Arrow package is loadable and we have the correct one
Expand All @@ -88,5 +88,5 @@ jobs:
uses: actions/upload-artifact@v2
with:
name: {{ "devdocs-script_os-${{ matrix.os }}_sysinstall-${{ matrix.system-install }}" }}
path: arrow/r/vignettes/script.sh
path: arrow/r/vignettes/developers/script.sh
if: always()
4 changes: 4 additions & 0 deletions r/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ navbar:
href: articles/developing.html
- text: Developers
menu:
- text: Developer Environment Setup
href: articles/developers/setup.html
- text: Common Workflow Tasks
href: articles/developers/workflow.html
- text: Debugging
href: articles/developers/debugging.html
reference:
Expand Down
Loading

0 comments on commit e417fbf

Please sign in to comment.