diff --git a/.mdl_style.rb b/.mdl_style.rb index 234a985..3d3a7cf 100644 --- a/.mdl_style.rb +++ b/.mdl_style.rb @@ -4,4 +4,4 @@ exclude_rule 'MD033' # Inline HTML exclude_rule 'MD034' # Bare URL used exclude_rule 'MD036' # Emphasis used instead of a header -rule 'MD013', :line_length => 120, :code_blocks => false, :tables => false \ No newline at end of file +rule 'MD013', :line_length => 120, :ignore_code_blocks => true, :tables => false \ No newline at end of file diff --git a/docs/source/data_management/fair_principles.md b/docs/source/data_management/fair_principles.md index 61b1b27..7d835cc 100644 --- a/docs/source/data_management/fair_principles.md +++ b/docs/source/data_management/fair_principles.md @@ -126,4 +126,4 @@ must be well-described to enable replication and/or combination in different set - **NIH** = National Institutes of Health - **NOAA** = National Oceanic and Atmospheric Administration -Credit: Content taken from a Confluence guide written by Anne Wilson, and modified by Shawn Polson in 2019 \ No newline at end of file +Credit: Content taken from a Confluence guide written by Anne Wilson, and modified by Shawn Polson in 2019 diff --git a/docs/source/data_management/file_formats/netcdf.md b/docs/source/data_management/file_formats/netcdf.md index be49adb..6711e6b 100644 --- a/docs/source/data_management/file_formats/netcdf.md +++ b/docs/source/data_management/file_formats/netcdf.md @@ -121,4 +121,4 @@ There are two netCDF data models: * [NetCDF ToolsUI](https://docs.unidata.ucar.edu/netcdf-java/current/userguide/toolsui_ref.html) * [NetCDF Workshop Materials](https://www.unidata.ucar.edu/software/netcdf/workshops/2011/index.html) -Credit: Content taken from a Confluence guide written by Doug Lindholm \ No newline at end of file +Credit: Content taken from a Confluence guide written by Doug Lindholm diff --git a/docs/source/data_management/metadata.md b/docs/source/data_management/metadata.md index be82b40..1bc910e 100644 --- a/docs/source/data_management/metadata.md +++ b/docs/source/data_management/metadata.md @@ -166,4 +166,4 @@ Provenance is often provided as descriptive prose, making machine-readable text - **LEMR** = LASP Extended Metadata Repository - **SPASE** = Space Physics Archive Search and Extract -Credit: Content taken from a Confluence guide written by Anne Wilson and Shawn Polson. \ No newline at end of file +Credit: Content taken from a Confluence guide written by Anne Wilson and Shawn Polson. diff --git a/docs/source/licensing.md b/docs/source/licensing.md index 0ec4506..11a442a 100644 --- a/docs/source/licensing.md +++ b/docs/source/licensing.md @@ -87,4 +87,4 @@ you’re distributing/producing. * [Choose a license](https://choosealicense.com/) * [Open Source Initiative (OSI)](https://opensource.org/licenses) * [The Turing Way overview of licensing](https://the-turing-way.netlify.app/reproducible-research/licensing) -* [Free and Open Source License Comparison chart](https://en.wikipedia.org/wiki/Comparison_of_free_and_open-source_software_licenses) \ No newline at end of file +* [Free and Open Source License Comparison chart](https://en.wikipedia.org/wiki/Comparison_of_free_and_open-source_software_licenses) diff --git a/docs/source/workflows/docker/beginner_guide_to_docker.md b/docs/source/workflows/docker/beginner_guide_to_docker.md index e3e264e..13db679 100644 --- a/docs/source/workflows/docker/beginner_guide_to_docker.md +++ b/docs/source/workflows/docker/beginner_guide_to_docker.md @@ -190,4 +190,4 @@ docker image prune * **ps** = Process Status * **tty** = TeleTYpe (terminal) -*Credit: Content taken from a Confluence guide written by Maxine Hartnett* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Maxine Hartnett* diff --git a/docs/source/workflows/docker/containerizing_idl_with_docker.md b/docs/source/workflows/docker/containerizing_idl_with_docker.md index eb9b6ac..ee03765 100644 --- a/docs/source/workflows/docker/containerizing_idl_with_docker.md +++ b/docs/source/workflows/docker/containerizing_idl_with_docker.md @@ -169,7 +169,11 @@ running on the host machine from within the non-IDL container. In this example a container is created from the official `CentOS` image: ```bash -docker container run -it --name=centos_container --rm -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker centos bash +docker container run -it \ + --name=centos_container --rm \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /usr/bin/docker:/usr/bin/docker \ + centos bash ``` This `docker container run` command generates a CentOS container and initiates an interactive connection to that @@ -240,7 +244,12 @@ Now, as in the previous example, spin up a non-IDL container based on the offici additional bind mount for the newly-created data volume: ```bash -docker container run --rm -it --name=centos_container -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -v SharedData:/src centos bash +docker container run --rm -it \ + --name=centos_container \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /usr/bin/docker:/usr/bin/docker \ + -v SharedData:/src \ + centos bash ``` #### In the Interactive Shell Inside the `CentOS` Container @@ -296,7 +305,12 @@ mounted to the `/src` directory in the container. Now create the non-IDL container named `centos_container`: ```bash -docker container run --rm -it --name=centos_container -v /Users/stmu4541/projects/docker/src:/src -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker lentos bash +docker container run --rm -it \ + --name=centos_container \ + -v /Users/stmu4541/projects/docker/src:/src \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /usr/bin/docker:/usr/bin/docker \ + lentos bash ``` Here, `lentos`, which immediately precedes the bash command specifies the official `centos` image. @@ -315,7 +329,12 @@ Using a Jenkins-based principal container is not significantly different than th latest `CentOS` OS. ```bash -docker container run --name=jenkins -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -p 8080:8080 jenkins/jenkins:lts-centos +docker container run \ + --name=jenkins \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /usr/bin/docker:/usr/bin/docker \ + -p 8080:8080 \ + jenkins/jenkins:lts-centos ``` Note that a Dockerfile is not required for this simple example since the container is created from the official `CentOS` @@ -418,4 +437,4 @@ docker container run -e DISPLAY=host.docker.internal:0 idlde_image * **VPN** = Virtual Private Network * **yum** = Yellowdog Updater, Modified -*Credit: Content taken from a Confluence guide written by Steven Mueller* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Steven Mueller* diff --git a/docs/source/workflows/docker/docker_compose_examples.md b/docs/source/workflows/docker/docker_compose_examples.md index f97ac8f..63837b9 100644 --- a/docs/source/workflows/docker/docker_compose_examples.md +++ b/docs/source/workflows/docker/docker_compose_examples.md @@ -359,4 +359,4 @@ And you will need some Flyway migration scripts to build up your DB schema howev * **apk** = Alpine Package Keeper * **pip** = Pip Installs Packages -*Credit: Content taken from a Confluence guide written by Gavin Medley and Maxine Hartnett* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Gavin Medley and Maxine Hartnett* diff --git a/docs/source/workflows/docker/export_display_with_docker.md b/docs/source/workflows/docker/export_display_with_docker.md index 32fc78a..cdec5a8 100644 --- a/docs/source/workflows/docker/export_display_with_docker.md +++ b/docs/source/workflows/docker/export_display_with_docker.md @@ -47,4 +47,4 @@ argument) allows the container access to the host machine X socket. * [Official Docker documentation](https://docs.docker.com/) -*Credit: Content taken from a Confluence guide written by Steven Mueller* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Steven Mueller* diff --git a/docs/source/workflows/docker/lasp_docker_registry.md b/docs/source/workflows/docker/lasp_docker_registry.md index 30ee218..b7528ad 100644 --- a/docs/source/workflows/docker/lasp_docker_registry.md +++ b/docs/source/workflows/docker/lasp_docker_registry.md @@ -167,4 +167,4 @@ WEBSUPPORT ticket or send an email to `web.support@lasp.colorado.edu` * **UI** = User Interface * **URL** = Uniform Resource Locator -*Credit: Content taken from a Confluence guide written by Maxine Hartnett* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Maxine Hartnett* diff --git a/docs/source/workflows/docker/lasp_image_registry.md b/docs/source/workflows/docker/lasp_image_registry.md index 1cb3767..bd125e2 100644 --- a/docs/source/workflows/docker/lasp_image_registry.md +++ b/docs/source/workflows/docker/lasp_image_registry.md @@ -78,7 +78,10 @@ docker pull docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration Or, the following command: ```bash -docker container run --user root --rm -it --name timDevContainer docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration bash +docker container run --user root --rm -it \ + --name timDevContainer \ + docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration \ + bash ``` This will launch a container based on the registry `dsinteg2_migration` image and connect to that container with a @@ -115,4 +118,4 @@ Only the image argument is relevant to the registry pull. * **TIM** = Total Irradiance Monitor * **URL** = Uniform Resource Locator -*Credit: Content taken from a Confluence guide written by Steven Mueller* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Steven Mueller* diff --git a/docs/source/workflows/jenkins_job_builder/containerize_jjb.md b/docs/source/workflows/jenkins_job_builder/containerize_jjb.md index 08f7356..c9cae4b 100644 --- a/docs/source/workflows/jenkins_job_builder/containerize_jjb.md +++ b/docs/source/workflows/jenkins_job_builder/containerize_jjb.md @@ -6,4 +6,4 @@ ## Acronyms -*Credit: Content taken from a Confluence guide written by Steven Mueller* \ No newline at end of file +*Credit: Content taken from a Confluence guide written by Steven Mueller* diff --git a/pyproject.toml b/pyproject.toml index a7e6c09..bcacbaa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,15 +2,15 @@ requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" -[tool.poetry] +[project] name = "developer-guide" version = "0.1.0" description = "Guidelines for software developers at LASP" authors = [ - "Matthew Bourque <Matthew.Bourque@lasp.colorado.edu>", - "Keira Brooks <Keira.Brooks@lasp.colorado.edu>", - "Veronica Martinez <Veronica.Martinez@lasp.colorado.edu>", - "Alex Ware <Alex.Ware@lasp.colorado.edu>"] + {name = "Matthew Bourque", email = "Matthew.Bourque@lasp.colorado.edu>"}, + {name = "Keira Brooks", email = "Keira.Brooks@lasp.colorado.edu>"}, + {name = "Veronica Martinez", email = "Veronica.Martinez@lasp.colorado.edu>"}, + {name = "Alex Ware", email = "Alex.Ware@lasp.colorado.edu>"}] readme = "README.md" license = "MIT" keywords = ["LASP", "Developer Guide", "Software"] @@ -20,6 +20,9 @@ classifiers = [ "Topic :: Scientific/Engineering", ] +[tool.poetry] +package-mode = false + [tool.poetry.dependencies] myst-parser = "^3.0.1" python = ">=3.9,<4"