Code

Add docs for Dev Containers#407

Code

Merged

SteveMacenski merged 107 commits intoros-navigation:masterros-navigation/docs.nav2.org:masterfrom ruffsl:devcontainerruffsl/navigation.ros.org:devcontainerCopy head branch name to clipboardApr 26, 2023

+639-199

Commits

Commits on Mar 27, 2023

• Checkin work in progress

  ruffsl

  committed
  ac45984

  Copy full SHA for ac45984

• Add section on Security

  ruffsl

  committed
  9de0304

  Copy full SHA for 9de0304

• Add description of container runtime and runArgs

  ruffsl

  committed
  7827bc6

  Copy full SHA for 7827bc6

• Add to using dev container

  ruffsl

  committed
  67a0f2e

  Copy full SHA for 67a0f2e

• Add subsection on Terminals

  ruffsl

  committed
  16ff8e1

  Copy full SHA for 16ff8e1

• Add subsection on Lifecycle

  ruffsl

  committed
  b05f070

  Copy full SHA for b05f070

Commits on Mar 28, 2023

• Add reminder to Lifecycle about pushing to remote

  ruffsl

  committed
  3bb9e62

  Copy full SHA for 3bb9e62

• Add subsection on Rebuilding

  ruffsl

  committed
  b3bded1

  Copy full SHA for b3bded1

Commits on Apr 11, 2023

• Rename file to own subtree

  ruffsl

  committed
  f0a0f2b

  Copy full SHA for f0a0f2b

• Enable markdown support for Sphinx

  Show description for 6880fe0
  ruffsl

  committed
  6880fe0

  Copy full SHA for 6880fe0

• Add dev_containers to root index

  ruffsl

  committed
  f1aa71f

  Copy full SHA for f1aa71f

• Fix missing URL

  ruffsl

  committed
  293e78e

  Copy full SHA for 293e78e

• Spin out content into development guide

  Show description for 6601960
  ruffsl

  committed
  6601960

  Copy full SHA for 6601960

• Add guides to index

  ruffsl

  committed
  839e4d2

  Copy full SHA for 839e4d2

• Fix subheading levels

  Show description for 9f7ed79
  ruffsl

  committed
  9f7ed79

  Copy full SHA for 9f7ed79

• Add reference to using remote docker host

  Show description for 2fd240c
  ruffsl

  committed
  2fd240c

  Copy full SHA for 2fd240c

• Update section Getting stared

  ruffsl

  committed
  2a70f54

  Copy full SHA for 2a70f54

• Enalbe admonitions and callouts highlighting

  Show description for c8a030d
  ruffsl

  committed
  c8a030d

  Copy full SHA for c8a030d

• Use tip admonition

  ruffsl

  committed
  024d0ed

  Copy full SHA for 024d0ed

• Use node admonition

  ruffsl

  committed
  1792267

  Copy full SHA for 1792267

• Rewording

  ruffsl

  committed
  10c2c76

  Copy full SHA for 10c2c76

• Fromatting

  ruffsl

  committed
  ec62d89

  Copy full SHA for ec62d89

• Use caution admonition

  ruffsl

  committed
  782bdde

  Copy full SHA for 782bdde

• Use hint admonition

  ruffsl

  committed
  26c0d5c

  Copy full SHA for 26c0d5c

• Wording

  ruffsl

  committed
  e16df70

  Copy full SHA for e16df70

• Wording

  ruffsl

  committed
  e05586d

  Copy full SHA for e05586d

• Formatting

  ruffsl

  committed
  71b0484

  Copy full SHA for 71b0484

• Add section intros

  ruffsl

  committed
  5ce6c6a

  Copy full SHA for 5ce6c6a

• Wording

  ruffsl

  committed
  d0651e1

  Copy full SHA for d0651e1

• Add seealso callout for Nav2 CI

  ruffsl

  committed
  b9c4c2e

  Copy full SHA for b9c4c2e

• Add hint callout for colcon extentions

  ruffsl

  committed
  a868f26

  Copy full SHA for a868f26

• Use attention admonition about runArgs

  ruffsl

  committed
  d15bec2

  Copy full SHA for d15bec2

• Update remarks on volumes

  Show description for 9b3deef
  ruffsl

  committed
  9b3deef

  Copy full SHA for 9b3deef

Commits on Apr 12, 2023

• Grammar

  ruffsl

  committed
  34098e5

  Copy full SHA for 34098e5

• Update notes on current runArgs

  Show description for d37e818
  ruffsl

  committed
  d37e818

  Copy full SHA for d37e818

• Add seealso callout for details on used runArgs

  ruffsl

  committed
  8693a3e

  Copy full SHA for 8693a3e

• Update remark about volumes

  ruffsl

  committed
  eced357

  Copy full SHA for eced357

• Formatting

  ruffsl

  committed
  e20e522

  Copy full SHA for e20e522

• Sort Formatting

  ruffsl

  committed
  63dd66b

  Copy full SHA for 63dd66b

• Install sphinx_copybutton

  Show description for 59e50f4
  ruffsl

  committed
  59e50f4

  Copy full SHA for 59e50f4

• Simplify install instructions

  ruffsl

  committed
  0ae0ca7

  Copy full SHA for 0ae0ca7

• Format install instructions

  ruffsl

  committed
  6d98af1

  Copy full SHA for 6d98af1

• Wording

  ruffsl

  committed
  e471b5e

  Copy full SHA for e471b5e

• Add missing annotating

  Show description for 898377d
  ruffsl

  committed
  898377d

  Copy full SHA for 898377d

• Update build instructions

  ruffsl

  committed
  1c3996f

  Copy full SHA for 1c3996f

• Update docker instructions

  ruffsl

  committed
  9edf13b

  Copy full SHA for 9edf13b

• Default branch is sadly not named rolling

  Show description for 2fd7f7f
  ruffsl

  committed
  2fd7f7f

  Copy full SHA for 2fd7f7f

• Add descriptions for each build method

  ruffsl

  committed
  a7362a9

  Copy full SHA for a7362a9

• Wording

  ruffsl

  committed
  23c44ad

  Copy full SHA for 23c44ad

• Expand docker docs with links

  ruffsl

  committed
  a0775f2

  Copy full SHA for a0775f2

Commits on Apr 13, 2023

• Formatting

  ruffsl

  committed
  e146253

  Copy full SHA for e146253

• Add note that rolling is tracked via main branch

  ruffsl

  committed
  4fa977b

  Copy full SHA for 4fa977b

• Add tip for development workflow

  ruffsl

  committed
  7f645c9

  Copy full SHA for 7f645c9

• Add attention to terminals

  ruffsl

  committed
  276a2fa

  Copy full SHA for 276a2fa

• Add hint to terminals

  Show description for 646bf96
  ruffsl

  committed
  646bf96

  Copy full SHA for 646bf96

• Add important to lifecycle

  ruffsl

  committed
  bdd35ee

  Copy full SHA for bdd35ee

• Add caution to rebuilding

  ruffsl

  committed
  0545b81

  Copy full SHA for 0545b81

• Add details to rebuilding without cache

  ruffsl

  committed
  2f4eaf6

  Copy full SHA for 2f4eaf6

• Add caution to rebuilding without cache

  ruffsl

  committed
  801ab3d

  Copy full SHA for 801ab3d

• Add tip to rebuilding

  ruffsl

  committed
  dd3add4

  Copy full SHA for dd3add4

• Split Visualization Guide into separate PR

  ruffsl

  committed
  e298804

  Copy full SHA for e298804

• Use seealso admonition

  ruffsl

  committed
  113d8b6

  Copy full SHA for 113d8b6

• Upgrade security caution to danger

  Show description for a9159c8
  ruffsl

  committed
  a9159c8

  Copy full SHA for a9159c8

• Wording

  ruffsl

  committed
  c1c01bb

  Copy full SHA for c1c01bb

Commits on Apr 14, 2023

• Wording

  ruffsl

  committed
  2ab5264

  Copy full SHA for 2ab5264

• Add tip about logfile

  Show description for aee86e7
  ruffsl

  committed
  aee86e7

  Copy full SHA for aee86e7

• Typo

  ruffsl

  committed
  bc736e0

  Copy full SHA for bc736e0

Commits on Apr 18, 2023

• Comment out runArgs unintended side effects

  Show description for aad97af
  ruffsl

  committed
  aad97af

  Copy full SHA for aad97af

• Wording

  ruffsl

  committed
  076596f

  Copy full SHA for 076596f

• Update requirements.txt

  Show description for 7a536f8
  ruffsl

  committed
  7a536f8

  Copy full SHA for 7a536f8

• Add new dependencies

  ruffsl

  committed
  57ba320

  Copy full SHA for 57ba320

• Fix version for new dependencies

  ruffsl

  committed
  737b7d6

  Copy full SHA for 737b7d6

• Move development files

  Show description for 2f5dd35
  ruffsl

  committed
  2f5dd35

  Copy full SHA for 2f5dd35

• Update README

  Show description for 95ca826
  ruffsl

  committed
  95ca826

  Copy full SHA for 95ca826

• Update Dockerfile

  Show description for 453722b
  ruffsl

  committed
  453722b

  Copy full SHA for 453722b

• Update CI

  Show description for cee4b24
  ruffsl

  committed
  cee4b24

  Copy full SHA for cee4b24

• Simplify Dockerfile

  ruffsl

  committed
  66f0fdb

  Copy full SHA for 66f0fdb

• Simplify apt install

  ruffsl

  committed
  d021595

  Copy full SHA for d021595

• Expand apt install

  ruffsl

  committed
  b6c878b

  Copy full SHA for b6c878b

• Sort apt install

  ruffsl

  committed
  f53400d

  Copy full SHA for f53400d

• Prune apt install

  ruffsl

  committed
  61752b8

  Copy full SHA for 61752b8

• Update Dockerfile to match CI

  Show description for 0126257
  ruffsl

  committed
  0126257

  Copy full SHA for 0126257

• Fix working_directory

  Show description for f0e2f3f
  ruffsl

  committed
  f0e2f3f

  Copy full SHA for f0e2f3f

• Update attention

  Show description for 5b50364
  ruffsl

  committed
  5b50364

  Copy full SHA for 5b50364

• Avoid the use of export

  Show description for dad2431
  ruffsl

  committed
  dad2431

  Copy full SHA for dad2431

• Rewording

  ruffsl

  committed
  0cb6fb3

  Copy full SHA for 0cb6fb3

Commits on Apr 20, 2023

• Refactor build and devcontainer docs

  ruffsl

  committed
  e6aa6e4

  Copy full SHA for e6aa6e4

• Set language to english

  Show description for 9888bc7
  ruffsl

  committed
  9888bc7

  Copy full SHA for 9888bc7

• Exclude README file

  Show description for e385b01
  ruffsl

  committed
  e385b01

  Copy full SHA for e385b01

• Orphan files not included in any toctree

  Show description for a55e3f9
  ruffsl

  committed
  a55e3f9

  Copy full SHA for a55e3f9

• Stage renaming links

  ruffsl

  committed
  7480513

  Copy full SHA for 7480513

• Rename indexs and headings

  ruffsl

  committed
  7c54a15

  Copy full SHA for 7c54a15

• Use globe for hidden toctree

  ruffsl

  committed
  316d497

  Copy full SHA for 316d497

• Add guide index for discoverability

  ruffsl

  committed
  d221394

  Copy full SHA for d221394

• Reorder caution admonition as a TLDR

  ruffsl

  committed
  f9d1804

  Copy full SHA for f9d1804

• Add body text to index

  ruffsl

  committed
  a43c001

  Copy full SHA for a43c001

• Combine contribute into development guide

  ruffsl

  committed
  265c2cb

  Copy full SHA for 265c2cb

• Add hidden toctree without maxdepth

  Show description for 2f98a97
  ruffsl

  committed
  2f98a97

  Copy full SHA for 2f98a97

• Use seealso admonition for dev container links

  ruffsl

  committed
  42689a6

  Copy full SHA for 42689a6

• Revert change to avoid duplicate toctree entries

  Show description for ef233b2
  ruffsl

  committed
  ef233b2

  Copy full SHA for ef233b2

• Instal sphinx-autobuild

  ruffsl

  committed
  99a806e

  Copy full SHA for 99a806e

• Add make build task

  Show description for c3a1e43
  ruffsl

  committed
  c3a1e43

  Copy full SHA for c3a1e43

• Add .dockerignore file

  ruffsl

  committed
  fbecd88

  Copy full SHA for fbecd88

• Add auto build option

  ruffsl

  committed
  8bc021f

  Copy full SHA for 8bc021f

• Show all warning

  Show description for 33842a8
  ruffsl

  committed
  33842a8

  Copy full SHA for 33842a8

• Add devcontainer config

  ruffsl

  committed
  068a547

  Copy full SHA for 068a547

Commits on Apr 26, 2023

• Fix artifact path

  Show description for c95f117
  ruffsl

  committed
  c95f117

  Copy full SHA for c95f117