Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should there be a link in the Readme.MD for the VS Code Extension? #7

Open
smflorentino opened this issue Nov 10, 2016 · 1 comment

Comments

@smflorentino
Copy link
Member

Trying to become an ARM power user, I've stumbled across 3 different pages for doing so with VSCode:
(1) https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools
(2) https://azure.microsoft.com/en-us/documentation/articles/resource-manager-vs-code/
(3) https://github.com/Azure/azure-xplat-arm-tooling (this repo)

They each have vital information:
(1) describes the extension's features
(2) describes how to use the extension
(3) duplicates some documentation from (2), but has the raw file you need to complete the steps in (2).

They don't link to each other:
(2) links to (3).
(1) links to (3).
(3) links to neither.

Getting started, it was very hard to piece all of these together:

  • The VSCode extension isn't listed as a prereq in this repo's readme.md page. Is it required to be installed before the JSON snippets are added?
  • Once I installed the VSCode extension, I didn't see a new language type so I wasn't sure how to "use" the extension. Site (1) only described the features. Then I stumbled across site (2), which explained how to use it.

My asks:
Can we have all of the above pages link to each other? In case someone does a search and ends up one of the three (like me), they can still find their way to the right place. I think site 2 has the most comprehensive guide.
-I can submit a PR for this repo's readme.md. I'd like to link to (1) and (2)
-I can submit a PR for site (2) as a separate PR / GH issue.
-Not sure who to contact about (1) but I think that is the critical point of entry for new extension users and should link to (2).

@philon-msft
Copy link
Contributor

Thanks for the suggestions, @smflorentino! I left a comment on the how-to article with a link to the extension's page on the marketplace. I also created a work item to update the marketplace description to include a link to the article. Feel free to submit a PR to add links to this repo's README.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants