doc updates #2562
doc updates #2562
Conversation
microsoft-github-policy-service
bot
added
the
Needs: Triage 🔍
matebarabas
added
Type: Documentation 📄
jaredfholgate
left a comment
jaredfholgate
left a comment
There was a problem hiding this comment.
I'm still working on this as can't get past the first phase. Will add more things once I figure out what is broken.
| 1. To install [Spec Kit](https://github.com/github/Spec-Kit) locally, run the following command: | ||
|
|
||
| ```bash | ||
| uv tool install specify-cli --from git+https://github.com/github/spec-kit.git |
There was a problem hiding this comment.
In VSCode Terminal this failed to add it to my path properly. I had to run in an elevated terminal for it to do that and then restart all VSCode sessions.
There was a problem hiding this comment.
I'll add elevated terminal as a requirement.
| 3. Initialize a new Spec Kit project: | ||
|
|
||
| ```bash | ||
| specify init . |
There was a problem hiding this comment.
Add a step before this to run git config --global init.defaultBranch main if not already set. There is no way to tell specify the branch name.
There was a problem hiding this comment.
Extra step added.
|
|
||
| {{% /expand %}} | ||
|
|
||
| 4. If you're using git, it is recommended to make an initial commit now to capture the bootstrapped state of your project, with a comment of something like `Initial commit - Spec Kit bootstrap`. |
There was a problem hiding this comment.
Spec Kit makes this initial commit by default. There is nothing to do here.
| {{% tab title="Bicep" %}} | ||
|
|
||
| ```markdown | ||
| /speckit.constitution Fill the constitution with the typical requirements of a legacy Azure workload (needed to be retained for compliance reasons; no high-availability requirements; no disaster recovery requirements; no scalability requirements), defined as infrastructure-as-code, in Bicep language, built only with Azure Verified Modules (AVM). Always try to implement every feature with Bicep first (using Infra-as-code), and only use custom scripts when it's not possible otherwise. Follow IaC best practices: define everything in a single template, and let ARM manage dependencies and the order of deployment for each Azure resource. |
There was a problem hiding this comment.
This command just hangs for me like this:
There was a problem hiding this comment.
Ok, it eventually got past this, but hung for about 5 minutes in my environment.
There was a problem hiding this comment.
Every step takes somewhere between 5 and 10 minutes for the first run.
Overview/Summary
Documentation updates
This PR fixes/adds/changes/removes
As part of this Pull Request I have
mainbranch