Doc fix (#141)

* redocument

* update news/desc

* update links

* update actions

Author: hongooi73

.github/workflows/check-standard.yaml

@@ -17,19 +17,19 @@ jobs:
         config:
           - {os: windows-latest, r: 'release'}
           - {os: macOS-latest, r: 'release'}
-          - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
+          - {os: ubuntu-24.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
 
     env:
       R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
       RSPM: ${{ matrix.config.rspm }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0  # required for mirroring, see https://stackoverflow.com/a/64272409/474349
 
       - name: Copy to Cloudyr
-        if: runner.os == 'Linux' && github.ref == 'refs/heads/master' && github.repository_owner == 'Azure'
+        if: github.repository_owner == 'Azure' && runner.os == 'Linux' && github.ref == 'refs/heads/master'
         env:
           token: "${{ secrets.ghPat }}"
         # git config hack required, see https://stackoverflow.com/q/64270867/474349
@@ -39,11 +39,11 @@ jobs:
             xargs -L1 git config --unset-all
           git push --prune https://token:[email protected]/${CLOUDYR_REPO}.git +refs/remotes/origin/*:refs/heads/* +refs/tags/*:refs/tags/*
 
-      - uses: r-lib/actions/setup-r@master
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
 
-      - uses: r-lib/actions/setup-pandoc@master
+      - uses: r-lib/actions/setup-pandoc@v2
 
       - name: Query dependencies
         run: |
@@ -54,11 +54,11 @@ jobs:
 
       - name: Cache R packages
         if: runner.os != 'Windows'
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ${{ env.R_LIBS_USER }}
           key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
-          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+          # restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-5-
 
       - name: Install system dependencies
         if: runner.os == 'Linux'
@@ -85,13 +85,13 @@ jobs:
 
       - name: Upload check results
         if: failure()
-        uses: actions/upload-artifact@main
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ runner.os }}-r${{ matrix.config.r }}-results
           path: check
 
       - name: Update Cloudyr drat
-        if: success() && runner.os == 'Linux' && github.ref == 'refs/heads/master' && github.repository_owner == 'Azure'
+        if: success() && github.repository_owner == 'Azure' && runner.os == 'Linux' && github.ref == 'refs/heads/master' 
         env:
           token: "${{ secrets.ghPat }}"
         run: |

DESCRIPTION

@@ -1,11 +1,11 @@
 Package: AzureStor
 Title: Storage Management in 'Azure'
-Version: 3.7.0.9000
+Version: 3.7.1
 Authors@R: c(
     person("Hong", "Ooi", , "[email protected]", role = c("aut", "cre")),
     person("Microsoft", role="cph")
     )
-Description: Manage storage in Microsoft's 'Azure' cloud: <https://azure.microsoft.com/en-us/product-categories/storage/>. On the admin side, 'AzureStor' includes features to create, modify and delete storage accounts. On the client side, it includes an interface to blob storage, file storage, and 'Azure Data Lake Storage Gen2': upload and download files and blobs; list containers and files/blobs; create containers; and so on. Authenticated access to storage is supported, via either a shared access key or a shared access signature (SAS). Part of the 'AzureR' family of packages.
+Description: Manage storage in Microsoft's 'Azure' cloud: <https://azure.microsoft.com/en-us/products/category/storage/>. On the admin side, 'AzureStor' includes features to create, modify and delete storage accounts. On the client side, it includes an interface to blob storage, file storage, and 'Azure Data Lake Storage Gen2': upload and download files and blobs; list containers and files/blobs; create containers; and so on. Authenticated access to storage is supported, via either a shared access key or a shared access signature (SAS). Part of the 'AzureR' family of packages.
 License: MIT + file LICENSE
 URL: https://github.com/Azure/AzureStor https://github.com/Azure/AzureR
 BugReports: https://github.com/Azure/AzureStor/issues
@@ -31,4 +31,4 @@ Suggests:
     processx,
     uuid
 Roxygen: list(markdown=TRUE, r6=FALSE, old_usage=TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.1

NEWS.md

@@ -1,5 +1,6 @@
 # AzureStor 3.7.1
 
+- Update documentation links for CRAN
 - Fix a bug that caused a generated SAS to be invalid (thanks to Peter Solymos, #134)
 
 # AzureStor 3.7.0

R/add_methods.R

@@ -40,9 +40,9 @@
 #' @seealso
 #' [get_storage_account], [delete_storage_account], [az_storage]
 #'
-#' [Azure Storage documentation](https://docs.microsoft.com/en-us/azure/storage/),
-#' [Azure Storage Provider API reference](https://docs.microsoft.com/en-us/rest/api/storagerp/),
-#' [Azure Data Lake Storage hierarchical namespaces](https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-namespace)
+#' [Azure Storage documentation](https://learn.microsoft.com/en-us/azure/storage/),
+#' [Azure Storage Provider API reference](https://learn.microsoft.com/en-us/rest/api/storagerp/),
+#' [Azure Data Lake Storage hierarchical namespaces](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-namespace)
 #'
 #' @examples
 #' \dontrun{
@@ -90,7 +90,7 @@ NULL
 #'
 #' @seealso
 #' [create_storage_account], [delete_storage_account], [az_storage],
-#' [Azure Storage Provider API reference](https://docs.microsoft.com/en-us/rest/api/storagerp/)
+#' [Azure Storage Provider API reference](https://learn.microsoft.com/en-us/rest/api/storagerp/)
 #'
 #' @examples
 #' \dontrun{
@@ -129,7 +129,7 @@ NULL
 #'
 #' @seealso
 #' [create_storage_account], [get_storage_account], [az_storage],
-#' [Azure Storage Provider API reference](https://docs.microsoft.com/en-us/rest/api/storagerp/)
+#' [Azure Storage Provider API reference](https://learn.microsoft.com/en-us/rest/api/storagerp/)
 #'
 #' @examples
 #' \dontrun{

R/az_storage.R

@@ -16,7 +16,7 @@
 #' - `regen_key(key)`: Regenerates (creates a new value for) an access key. The argument `key` can be 1 or 2.
 #'
 #' @section Initialization:
-#' Initializing a new object of this class can either retrieve an existing storage account, or create a account on the host. Generally, the best way to initialize an object is via the `get_storage_account`, `create_storage_account` or `list_storage_accounts` methods of the [az_resource_group] class, which handle the details automatically.
+#' Initializing a new object of this class can either retrieve an existing storage account, or create a account on the host. Generally, the best way to initialize an object is via the `get_storage_account`, `create_storage_account` or `list_storage_accounts` methods of the [AzureRMR::az_resource_group] class, which handle the details automatically.
 #'
 #' @section Creating a shared access signature:
 #' Note that you don't need to worry about this section if you have been _given_ a SAS, and only want to use it to access storage.
@@ -73,12 +73,12 @@
 #' [blob_endpoint], [file_endpoint],
 #' [create_storage_account], [get_storage_account], [delete_storage_account], [Date], [POSIXt]
 #'
-#' [Azure Storage Provider API reference](https://docs.microsoft.com/en-us/rest/api/storagerp/),
-#' [Azure Storage Services API reference](https://docs.microsoft.com/en-us/rest/api/storageservices/)
+#' [Azure Storage Provider API reference](https://learn.microsoft.com/en-us/rest/api/storagerp/),
+#' [Azure Storage Services API reference](https://learn.microsoft.com/en-us/rest/api/storageservices/)
 #'
-#' [Create an account SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas),
-#' [Create a user delegation SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas),
-#' [Create a service SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas)
+#' [Create an account SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas),
+#' [Create a user delegation SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas),
+#' [Create a service SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-service-sas)
 #'
 #' @examples
 #' \dontrun{

R/azcopy.R

@@ -20,7 +20,7 @@
 #' @seealso
 #' [processx::run], [download_blob], [download_azure_file], [download_adls_file]
 #'
-#' [AzCopy page on Microsoft Docs](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-v10)
+#' [AzCopy page on Microsoft Docs](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-v10)
 #'
 #' [AzCopy GitHub repo](https://github.com/Azure/azure-storage-azcopy)
 #' @examples

R/blob_client_funcs.R

@@ -279,7 +279,7 @@ delete_blob_container.blob_endpoint <- function(endpoint, name, confirm=TRUE, le
 #' [blob_container], [az_storage], [storage_download], [call_azcopy], [list_blob_snapshots], [list_blob_versions]
 #'
 #' [AzCopy version 10 on GitHub](https://github.com/Azure/azure-storage-azcopy)
-#' [Guide to the different blob types](https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)
+#' [Guide to the different blob types](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)
 #'
 #' @examples
 #' \dontrun{

R/blob_lease.R

@@ -17,8 +17,8 @@
 #'
 #' @seealso
 #' [blob_container],
-#' [Leasing a blob](https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob),
-#' [Leasing a container](https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container)
+#' [Leasing a blob](https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob),
+#' [Leasing a container](https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container)
 #'
 #' @rdname lease
 #' @export

R/client_endpoint.R

@@ -17,7 +17,7 @@
 #' If multiple authentication objects are supplied, they are used in this order of priority: first an access key, then an AAD token, then a SAS. If no authentication objects are supplied, only public (anonymous) access to the endpoint is possible.
 #'
 #' @section Storage emulators:
-#' AzureStor supports connecting to the [Azure SDK](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator) and [Azurite](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azurite) emulators for blob and queue storage. To connect, pass the full URL of the endpoint, including the account name, to the `blob_endpoint` and `queue_endpoint` methods (the latter from the AzureQstor package). The warning about an unrecognised endpoint can be ignored. See the linked pages, and the examples below, for details on how to authenticate with the emulator.
+#' AzureStor supports connecting to the [Azure SDK](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-emulator) and [Azurite](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite) emulators for blob and queue storage. To connect, pass the full URL of the endpoint, including the account name, to the `blob_endpoint` and `queue_endpoint` methods (the latter from the AzureQstor package). The warning about an unrecognised endpoint can be ignored. See the linked pages, and the examples below, for details on how to authenticate with the emulator.
 #'
 #' Note that the Azure SDK emulator is no longer being actively developed; it's recommended to use Azurite for development work.
 #'

R/sas.R

@@ -39,12 +39,12 @@
 #' [blob_endpoint], [file_endpoint],
 #' [Date], [POSIXt]
 #'
-#' [Azure Storage Provider API reference](https://docs.microsoft.com/en-us/rest/api/storagerp/),
-#' [Azure Storage Services API reference](https://docs.microsoft.com/en-us/rest/api/storageservices/)
+#' [Azure Storage Provider API reference](https://learn.microsoft.com/en-us/rest/api/storagerp/),
+#' [Azure Storage Services API reference](https://learn.microsoft.com/en-us/rest/api/storageservices/)
 #'
-#' [Create an account SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas),
-#' [Create a user delegation SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas),
-#' [Create a service SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas)
+#' [Create an account SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas),
+#' [Create a user delegation SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas),
+#' [Create a service SAS](https://learn.microsoft.com/en-us/rest/api/storageservices/create-service-sas)
 #'
 #' @examples
 #' # account SAS valid for 7 days