docs icon indicating copy to clipboard operation
docs copied to clipboard

Update "Supported S3 Commands" Page with info from GitHub

Open ferristocrat opened this issue 2 years ago • 0 comments

Overview

  • The following GitHub document has more details about our S3 compatibility than our documentation site
    • GitHub Doc: https://github.com/storj/gateway-st/blob/main/docs/s3-compatibility.md
    • Relevant Docs Page: https://docs.storj.io/dcs/api-reference/s3-compatible-gateway/supported-s3-commands
  • We should ensure the docs.storj.io page has the additional details from GitHub since users are more likely to find the docs page than our GitHub doc

Acceptance Criteria

  • Page Updates
    • Compatibility table updated on docs.storj.io
    • All additional context is added to docs.storj.io
    • Add link from docs.storj.io to the GitHub doc with something like "for the most up-to-date compatibility information, please refer to our Gateway-MT GitHub here: https://github.com/storj/gateway-st/blob/main/docs/s3-compatibility.md"
  • Fix Broken Link
    • The link in https://github.com/storj/gateway-mt/blob/main/docs/gateway-mt.md#s3-api-compatibility-using-docker under title "Documentation" called "Using the S3 Gateway" is broken, it is trying to point to https://docs.storj.io/api-reference/s3-gateway which is a page that no longer exists or was renamed
      • I.e. if you click on "S3-compatibility list of GatewayMT" in this docs page https://docs.storj.io/dcs/api-reference/s3-compatible-gateway it sends you to the GitHub page mentioned above which in turn has the broken link back to a non existent docs page

ferristocrat avatar Jan 25 '23 17:01 ferristocrat