Skip to content

AzureBlobConfiguration.md opens by describing Azure Service Bus, not Blob storage #70

Description

@iancooper

Problem

contents/AzureBlobConfiguration.md documents the Azure Blob Archive Provider — the blob storage backend for the Outbox Archiver. But its ## General section describes Azure Service Bus, a message broker, and links twice to Service Bus documentation.

Line 4 currently reads:

Azure Service Bus (ASB) is a fully managed enterprise message broker and is well documented Brighter handles the details of sending to or receiving from ASB. You may find it useful to understand the concepts of the ASB.

This is byte-identical to line 4 of contents/AzureServiceBusConfiguration.md, so it looks like a copy-paste that was never rewritten for the new page. The rest of the file — Connection, Permissions, Options — is correct and genuinely about blob storage.

Why it matters

The first thing a reader sees on this page is a description of the wrong Azure service, pointing at the wrong product's documentation. Anyone arriving to configure the archiver has to read past it and work out that the two links are irrelevant.

The page became more visible recently: it was unreachable from SUMMARY.md until it was added to the table of contents, nested under Azure Blob Archive Provider.

Suggested fix

Replace the ## General paragraph with one describing Azure Blob Storage and the archiver's use of it, linking to the Azure Blob Storage docs instead. contents/AzureBlobArchiveProvider.md already frames the component correctly and is a reasonable model.

Smaller issue in the same file

Line 17 is missing a word:

TagBlobs : if this is set to True the defined in TagsFunc will be written to the blobs

Presumably "…the tags defined in TagsFunc…". Worth fixing in the same pass.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions