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

Readme: remove docker, add chocolatey. Update framework targets #315

Merged
merged 16 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-APIdocs-layer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ on:
- build-metadata.sh

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
bart-vmware marked this conversation as resolved.
Show resolved Hide resolved
cancel-in-progress: true

env:
Expand Down
11 changes: 5 additions & 6 deletions .github/workflows/build-and-stage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ on:
- "!metadata.conf"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

permissions:
Expand Down Expand Up @@ -74,21 +74,20 @@ jobs:
- name: Deploy to staging slot
uses: azure/webapps-deploy@v3
id: deploy-to-webapp
with:
with:
app-name: ${{ vars.AZURE_WEBAPP_NAME }}
images: ${{ vars.DOCKER_REGISTRY }}/documentation:${{ env.IMAGE_TAG }}
slot-name: ${{ env.SLOT_NAME }}

- name: If PR, comment with the preview link
if: ${{ github.event_name == 'pull_request' }}
uses: mshick/add-pr-comment@v2
with:
message: |
## Preview link: https://${{ vars.AZURE_WEBAPP_NAME }}-${{ env.SLOT_NAME }}.azurewebsites.net
## Preview link: https://${{ vars.AZURE_WEBAPP_NAME }}-${{ env.SLOT_NAME }}.azurewebsites.net

- Your changes have been deployed to the preview site. The preview site will update as you add more commits to this branch.
- The preview link is shareable, but will be deleted when the pull request is merged or closed.

> *This is an automated message.*
repo-token: ${{ secrets.GITHUB_TOKEN }}

2 changes: 1 addition & 1 deletion .github/workflows/build-base-layer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- docfx/

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

env:
Expand Down
13 changes: 7 additions & 6 deletions README.md
bart-vmware marked this conversation as resolved.
Show resolved Hide resolved
bart-vmware marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Visual Studio Code users may find the [Docs Authoring Pack](https://marketplace.

As you get familiar with DocFX, you'll notice the addition of a YAML header in the markdown files. Values in this header let you control page design, as well as set the page's `UID`. With this, you can create `xref` as well as use DocFX's `@` shorthand. Learn more about [linking in DocFX](https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html).

**Note** it should be very rare that you hardcode a link to an 'HTML' page with your markdown. Instead, use its `UID` and let the path get calculated, as well as get links validated when building the project.
> [!NOTE]
> It should be very rare that you hardcode a link to an 'HTML' page with your markdown. Instead, use its `UID` and let the path get calculated, as well as get links validated when building the project.

### Page display options

Expand All @@ -44,7 +45,7 @@ In the YAML header of a page's markdown, you have options to turn page elements

## Creating a new blog post

Create a new `.md` file in the `articles` directory. Name the file something that is URL safe. In `/articles/index.md` add a shorthand link to the document as well as a short description. If the post should also be included in Steeltoe's RSS feed, add a link entry in `articles/rss.xml`.
Create a new `.md` file in the `articles` directory. Name the file something that is URL safe. In `/articles/index.md` add a shorthand link to the document as well as a short description.

Here is a starter blog post:

Expand Down Expand Up @@ -147,15 +148,15 @@ This documentation site is interconnected with Steeltoe's [main site](https://gi
# main site -> https://steeltoe.io
docfx build --globalMetadataFiles main-site.json

# main site -> https://dev.steeltoe.io
docfx build --globalMetadataFiles main-site.dev.json
# main site -> https://staging.steeltoe.io
docfx build --globalMetadataFiles main-site.staging.json

# main site -> http://localhost:9081
# main site -> http://localhost:8080
docfx build --globalMetadataFiles main-site.localhost.json
```

### Run local HTTP server

```bash
docfx serve _site -p 9082
docfx serve _site -p 8082
```
3 changes: 0 additions & 3 deletions main-site.dev.json

This file was deleted.

2 changes: 1 addition & 1 deletion main-site.localhost.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"_rootHost": "http://localhost:9081"
"_rootHost": "http://localhost:8080"
}
3 changes: 3 additions & 0 deletions main-site.staging.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"_rootHost": "https://staging.steeltoe.io"
}
Loading