Skip to content

Commit

Permalink
Merge pull request #213 from sorru94/fix-typo-docs-upload
Browse files Browse the repository at this point in the history
Fix typos in commits for documentation
  • Loading branch information
harlem88 authored Nov 14, 2024
2 parents 3bff98e + df07ec0 commit 6aeba0e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
15 changes: 9 additions & 6 deletions .github/workflows/doc-generation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,20 @@ jobs:
rm -rf docs/$DOCS_DIRNAME
mkdir -p docs/$DOCS_DIRNAME/api
cp -r astarte-device-sdk-zephyr/doc/_build/doxygen/html/* docs/$DOCS_DIRNAME/api
- name: Update symlink
working-directory: ./docs/device-sdks/zephyr
run: |
rm -f "latest"
latest_version=$(ls -d * | grep -v snapshot | sort -V | tail -n 1)
if [ -z $latest_version ]; then latest_version="snapshot"; fi
ln -sf "$latest_version" latest
- name: Commit files
working-directory: ./docs
run: |
git config --local user.email "[email protected]"
git config --local user.name "Astarte Bot"
git add .
git diff-index --quiet HEAD || git commit -m "Update Zephyer SDK documentation"
git diff-index --quiet HEAD || git commit -m "Update Zephyr SDK documentation"
- name: Push changes
working-directory: ./docs
run: |
Expand All @@ -118,10 +125,6 @@ jobs:
repository: astarte-platform/sdk-doc
ssh-key: ${{ secrets.SDK_DOC_DEPLOY_KEY }}
path: sdk-doc
- name: Set up Python 3.12
uses: actions/setup-python@v4
with:
python-version: 3.12
- name: Check release branch
id: check-release-branch
working-directory: ./astarte-device-sdk-zephyr
Expand Down Expand Up @@ -158,7 +161,7 @@ jobs:
git config --local user.email "[email protected]"
git config --local user.name "Astarte Bot"
git add .
git diff-index --quiet HEAD || git commit -m "Update Python SDK get started"
git diff-index --quiet HEAD || git commit -m "Update Zephyr SDK get started"
- name: Push changes
if: steps.commit-changes.conclusion == 'success'
working-directory: ./sdk-doc
Expand Down
6 changes: 3 additions & 3 deletions get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ should have added a set of TLS certificates appropriate to reach the Astarte ser
To add this module as a dependency to an application the application's manifest file should be
modified in the following way.
First, a new remote should be added:
```yml
```yaml
remotes:
# ... other remotes ...
- name: astarte-platform
url-base: https://github.com/astarte-platform
```
Second, a new entry should be added to the projects list:
```yml
```yaml
projects:
# ... other projects ...
- name: astarte-device-sdk-zephyr
Expand Down Expand Up @@ -55,7 +55,7 @@ pip install -r ./astarte-device-sdk-zephyr/scripts/requirements.txt
A minimal set of Zephyr functionalities should be enabled for the Astarte device to work.
Modules such as MbedTLS, base64, and MQTT provide the necessary functionality.

```conf
```kconfig
# ... Hardware dependent networking configuration ...
# Astarte device SDK
Expand Down

0 comments on commit 6aeba0e

Please sign in to comment.