microsoft / microsoft/winget-cli-restsource

README section on Cosmos DB setup references things that don't exist in the document

Open
#167 0 comments 0 reactions 1 assignee View on GitHub

@RDMacLachlan is already working on this.

Since Sep 29, 2022.

Issue-Docs
Dominant language
C#
Stars
317
Forks
79
PR merge metrics
No merged PRs in 30d

Description

The README.md file says this:

Create a CosmosDB database instance in Azure, using either the above instructions, or manually.

However, there's no "above instructions" that explain how to create a CosmosDB instance in Azure.

It also says:

If you've used the ARM templates as described above, your Database will be named WinGet and your Collection will be Manifests

As before, there's no ARM templates "described above".

After reading through the entirety of the document, I'm assuming the things this is referring to are located in the Automatically create a REST source section but I'm not entirely sure.

I've looked through previous diffs of this particular document and it doesn't look like this has ever been clear or accurate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.