Skip to content

Commit

Permalink
small documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
maxheld83 committed Sep 1, 2020
1 parent 8d6f34a commit aadd1b1
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 11 deletions.
11 changes: 7 additions & 4 deletions R/azure.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' Deploy a shiny app to [Microsoft Azure Web Apps for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/)
#' Deploy a shiny app to Azure
#'
#' Calls the [Azure Command-Line Interface (CLI)](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) with defaults suitable for deploying a shiny app.
#' Wraps several steps.
Expand Down Expand Up @@ -249,7 +249,7 @@ az_cli_run <- function(...) {
)
}

#' Shiny options for Microsoft Azure Web App for Containers
#' Shiny options for Azure
#'
#' Set shiny options as [required for an Azure Webapp](https://docs.microsoft.com/en-us/azure/app-service/containers/configure-custom-container):
#' - `options(shiny.port = as.integer(Sys.getenv('PORT'))`.
Expand Down Expand Up @@ -284,16 +284,19 @@ az_webapp_shiny_opts <- function() {

#' Get details of a web app
#'
#' @inheritParams az_webapp
#' @inheritDotParams az_webapp
#'
#' @family azure functions
#'
#' @export
az_webapp_show <- function(name, resource_group, slot = NULL, subscription, ...) {
az_webapp_show <- function(...) {
res <- az_cli_run(args = c(
"webapp", "show"
))
}

#' Embed a shiny app with Microsoft Azure Web Apps for Containers
#' Embed a shiny app hosted on Azure
#'
#' @inheritDotParams include_app2
#'
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ library(shinycaas)

## System Requirements

This package calls the [Microsoft Azure}(https://azure.microsoft.com/) Command-Line Interface (CLI).
This package calls the [Microsoft Azure](https://azure.microsoft.com/) Command-Line Interface (CLI).
To deploy to Azure, you need to [install the Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) any machine from which you want to deploy your shiny app.
There's no need to install the Azure CLI into your *production* image; you only need it at deploy time.
If you only deploy from GitHub Actions (recommended) you do not need to install anything; the Azure CLI is [included](https://docs.github.com/en/actions/reference/software-installed-on-github-hosted-runners) in all GitHub-hosted runners.
Expand Down
2 changes: 1 addition & 1 deletion man/az_webapp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/az_webapp_shiny_opts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion man/az_webapp_show.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/include_app2_azure.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ reference:
- contents:
- has_concept("helper functions")
- title: Azure
desc: Deploy a Shiny App to Microsoft Azure Web Apps for Containers
desc: >
Deploy a Shiny App to [Microsoft Azure Web Apps for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/)
- contents:
- has_concept("azure functions")
articles:
Expand Down

0 comments on commit aadd1b1

Please sign in to comment.