Skip to content

Commit

Permalink
Merge pull request #22 from keirthana/rename-folders
Browse files Browse the repository at this point in the history
Rename folders
  • Loading branch information
keirthana authored Jan 19, 2024
2 parents 56d6e80 + 408c551 commit 897534b
Show file tree
Hide file tree
Showing 167 changed files with 170 additions and 216 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/do-not-edit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ on:
branches-ignore:
- main
paths:
- 'ref/ams-configuration.md'
- 'reference/ams-configuration.md'
pull_request:
paths:
- 'ref/ams-configuration.md'
- 'reference/ams-configuration.md'

jobs:
check:
name: Fail
runs-on: ubuntu-latest
steps:
- name: Print error
run: echo "::error file=ref/ams-configuration.md::Never edit ref/ams-configuration.md manually - edit ref/ams-configuration.tmpl.md or ref/ams-configuration.yaml instead!"
run: echo "::error file=reference/ams-configuration.md::Never edit reference/ams-configuration.md manually - edit reference/ams-configuration.tmpl.md or reference/ams-configuration.yaml instead!"

- name: Exit
run: exit 1
2 changes: 1 addition & 1 deletion .github/workflows/docs-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
with:
files_ignore: |
.github
release-notes
reference/release-notes
- name: Find Anbox Cloud docs links
id: find-anbox-cloud-docs-links
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/generate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: Generate and commit AMS configuration doc
on:
push:
paths:
- 'ref/ams-configuration.tmpl.md'
- 'ref/ams-configuration.yaml'
- 'reference/ams-configuration.tmpl.md'
- 'reference/ams-configuration.yaml'
pull_request:
paths:
- 'ref/ams-configuration.tmpl.md'
- 'ref/ams-configuration.yaml'
- 'reference/ams-configuration.tmpl.md'
- 'reference/ams-configuration.yaml'

jobs:
generate:
Expand All @@ -22,12 +22,12 @@ jobs:
run: python scripts/generate-ams-config.py

- name: Show Markdown file
run: cat ref/ams-configuration.md
run: cat reference/ams-configuration.md

- name: Commit changes
if: ${{ github.ref == 'refs/heads/main' }}
uses: EndBug/add-and-commit@v9
with:
default_author: github_actions
message: 'Generate AMS configuration doc'
add: 'ref/ams-configuration.md'
add: 'reference/ams-configuration.md'
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
354 changes: 154 additions & 200 deletions index.md

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion ref/ams-http-api.md → reference/ams-http-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1155,7 +1155,7 @@ Output:
"images.version_lockstep": "true", // Prevent images of new minor releases to be pulled by AMS
"registry.filter": "", // (comma separated list) Filter out applications without matching tags
"registry.fingerprint": <fingerprint>, // (string) Fingerprint of registry certificate
"registry.mode": "pull", // (pull/push/manual) Whether AMS should act as a client or publisher automatically synchronizing applications with AAR, or manually doing so. Please refer to https://anbox-cloud.io/docs/exp/aar for all details.
"registry.mode": "pull", // (pull/push/manual) Whether AMS should act as a client or publisher automatically synchronizing applications with AAR, or manually doing so. Please refer to https://anbox-cloud.io/docs/explanation/aar for all details.

Check failure on line 1158 in reference/ams-http-api.md

View workflow job for this annotation

GitHub Actions / Check docs links

Incorrect docs link

Documentation links should point to Discourse
"registry.update_interval": "5s", // (time) Frequency of updates from registry
"registry.url": "https://127.0.0.1:3000", // (string) URL of Anbox Application Registry
"scheduler.strategy": "spread" // (spread|binpack) Container allocation schedule strategery
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Anbox Cloud team is pleased to announce the release of Anbox Cloud < release-version >.

Please see [component versions](https://anbox-cloud.io/docs/ref/component-versions) for a list of updated components.
Please see [component versions](https://anbox-cloud.io/docs/reference/component-versions) for a list of updated components.

## New features & improvements

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions scripts/generate-ams-config.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

tables = {}

with open("ref/ams-configuration.yaml", 'r') as f:
with open("reference/ams-configuration.yaml", 'r') as f:

config = yaml.safe_load(f)

Expand All @@ -23,7 +23,7 @@
tables[which] = table

# Open the template file for reading and the Markdown file for writing
with open("ref/ams-configuration.tmpl.md", 'r') as infile, open("ref/ams-configuration.md", 'w') as outfile:
with open("reference/ams-configuration.tmpl.md", 'r') as infile, open("reference/ams-configuration.md", 'w') as outfile:
outfile.write("<!-- DO NOT EDIT THIS FILE. IT IS GENERATED AUTOMATICALLY. -->\n")
outfile.write("<!-- Edit ams-configuration.tmpl.md and ams-configuration.yaml instead. -->\n\n")

Expand Down
4 changes: 2 additions & 2 deletions scripts/publish-pr.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

for one in data:
filename = one['filename']
if (filename == "ref/ams-configuration.yaml") or (filename == "ref/ams-configuration.tmpl.md"):
filename = "ref/ams-configuration.md"
if (filename == "reference/ams-configuration.yaml") or (filename == "reference/ams-configuration.tmpl.md"):
filename = "reference/ams-configuration.md"
print("Publish "+filename)
subprocess.call("./publish.sh "+filename, shell=True)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 897534b

Please sign in to comment.