removing docs from github repo #4978
Conversation
|
Some other things you'll need to update:
|
There was a problem hiding this comment.
Small tweaks to remove the en-us/ locale from the doc URLs.
@anthony-c-martin / @majastrz -- do we need to push a release of the VS Code extension to get the README update? or does it pull the readme dynamically?
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -4,7 +4,7 @@ If you haven't already, read the full [contribution guide](../CONTRIBUTING.md). | |||
|
|
|||
| ## Contributing to documentation | |||
|
|
|||
| * [ ] The contribution does not exist in any of the docs in either the root of the [docs](../docs) directory or the [specs](../docs/spec) | |||
| * [ ] All documentation contributions should be made directly in the [bicep documentation on Microsoft Docs](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/). | |||
There was a problem hiding this comment.
Can you remove the en-us/? The docs site will add this automatically according to the default locale of the user.
There was a problem hiding this comment.
I won't add a comment to each instance below, but please update all of the below links.
|
You also have a conflict from a different PR -- welcome to software development :) You will need to pull the latest from main by running @StephenWeatherford -- we are retiring the docs from GitHub including the linter rules. Can you or Uche make sure the PR you just merged gets reflected in Microsoft Docs as well? |
We'd need to do a push - it's bundled with the extension. |
|
I ran "git pull origin main" and removed "docs/linter-rules/prefer-interpolation.md" as well as every link with "en-us/". Hopefully this was enough! |
|
Probably best to check in the README.md and other changes that point to the new docs first, then wait on deleting any of the existing docs. Otherwise we risk current users and those with slightly outdated versions having broken links with their packaged README pointing to deleted docs. Perhaps discuss during today's meeting. |
|
One thing I just realized, should we remove most of the content on the readme? There is a lot of overlap with what's on the readme and what is on the overview doc. |
I think at some point, we should make the README.md more developer-focused and about the codebase, with a link to the public doc for general info about Bicep. We could create a separate task for that tho? |
There was a problem hiding this comment.
Looks good! @anthony-c-martin - the test failure does not look specific to Stephanie's changes. Can you confirm?
Yup, I've seen that same failure crop up on a bunch of different PRs - no idea what's causing it sadly. I've re-queued the build. |
Removing docs from github repo since all docs that have been removed are now published to Microsoft Docs
https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/