Skip to content

Commit

Permalink
Vitepress fixes 2 (PX4#3150)
Browse files Browse the repository at this point in the history
* Fix unsupported language {5}

* yarn.lock update

* Add github deploy workflow

* Tidy deploy workflow

* Delete Jenkinsfile

* Delete LANGS.md, yarn error log - not needed

* Add new repository repo

* Delete all README.md (replaced by index.md)

* Try force update of translations of ros control interface

* replace notes with info, as supported by vitepress
  • Loading branch information
hamishwillee authored Apr 3, 2024
1 parent 296a4f5 commit 23e06bf
Show file tree
Hide file tree
Showing 860 changed files with 2,035 additions and 49,876 deletions.
85 changes: 85 additions & 0 deletions .github/workflows/docs_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Deploy Docs

on:
push:
branches:
- 'main'
tags:
- 'v*'
#paths:
# - docs/**
pull_request:
branches:
- '*'
#paths:
# - docs/**

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

env:
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
#with:
#fetch-depth: 0 # Not needed if lastUpdated is not enabled

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn # or pnpm / yarn

- name: Install dependencies
run: yarn install

- name: Build with VitePress
run: |
yarn docs:build_ubuntu
touch .vitepress/dist/.nojekyll
#touch docs/.vitepress/dist/.nojekyll
- name: Upload artifact
if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged) }}
uses: actions/upload-artifact@v4
with:
name: px4_docs_build
path: .vitepress/dist # docs/.vitepress/dist/
retention-days: 1

deploy:
if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged) }}
needs: build
runs-on: ubuntu-latest

steps:
- name: Download Artifact
uses: actions/download-artifact@v4
with:
name: px4_docs_build
path: ~/_book

- name: Deploy
run: |
git clone https://${{ secrets.PX4BUILDBOT_USER }}:${{ secrets.PX4BUILDBOT_ACCESSTOKEN }}@github.com/PX4/docs.px4.io.git
rm -rf docs.px4.io/${BRANCH_NAME}
mkdir -p docs.px4.io/${BRANCH_NAME}
cp -r ~/_book/* docs.px4.io/${BRANCH_NAME}/
cd docs.px4.io
git config user.email "[email protected]"
git config user.name "PX4BuildBot"
git add ${BRANCH_NAME}
git commit -a -m "PX4 docs build update (vitepress) `date`"
git push origin master
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ logs
*.sublime-project
*.sublime-workspace

#Yarn log
yarn-error.log

# vitepress - user guide
node_modules/
Expand Down
79 changes: 0 additions & 79 deletions Jenkinsfile

This file was deleted.

4 changes: 0 additions & 4 deletions LANGS.md

This file was deleted.

37 changes: 9 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,11 @@
---
home: true
heroImage: /logo_pro_small.png
heroText: PX4 User Guide
tagline: PX4 is the *Professional Autopilot*, powering vehicles from cargo, mapping and surveillance drones through to ground vehicles and submersibles.
actionText: Learn More →
actionLink: /en/
search: false
features:
- title: Modular Architecture
details: PX4 is highly modular and extensible both in terms of hardware and software. It utilizes a port-based architecture – which means when developers add components, the extended system does not lose robustness or performance.
- title: Open Source
details: PX4 is co-developed with a global development community. The flightstack is not just fulfilling the needs of one lab or one company, but has been intended as a general toolkit and is widely used and adopted in the industry.
- title: Configurability
details: PX4 offers optimised APIs and SDKs for developers working with integrations. All the modules are self-contained and can be easily exchanged against a different module without modifying the core. Features are easy to deploy and reconfigure.
- title: Autonomy Stack
details: PX4 is designed to be deeply coupled with embedded computer vision for autonomous capabilities . The framework lowers the barrier of entry for developers working on localization and obstacle detection algorithms.
- title: Real-world Validation
details: Thousands of commercial PX4 based systems have been deployed worldwide. In parallel, dedicated flight test team clocking up thousands of flight hours each month running hardware and software tests to ensure the codebase’s safety and reliability.
- title: Permissive License
details: PX4 is free to use and modify under the terms of the permissive BSD 3-clause license. Which means the software also allows proprietary use and allows the releases under the license to be incorporated into proprietary products.
- title: Interoperability
details: Beyond being a robust flight stack, PX4 offers an ecosystem of supported devices. The project also leads the standardarization effort for the advancement of communications, peripherals integration, and power management solutions.
# PX4 User Guide

- title: Powerful Safety Features
details: Great safety features including automated failsafe behaviour, support for different return modes, parachutes etc. are by default already included in the codebase. The features are easily configurable and tunable for custom systems.
This repo contains the source code for the [PX4 User Guide](https://docs.px4.io/main/en/).
The guide is intended for people who want to:

footer: BSD 3-clause license
---
<Redirect to="/en/" />
* Add PX4-powered controllers to their drones
* Learn how to fly and plan missions using PX4
* Learn how to extend PX4 to support new features

> [!NOTE]
> [Contributions](https://docs.px4.io/main/en/contribute/docs.html) and [Translations](https://docs.px4.io/main/en/contribute/translation.html) to this guide are very welcome!
132 changes: 0 additions & 132 deletions de/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions de/actuators/README.md

This file was deleted.

1 change: 0 additions & 1 deletion de/advanced/README.md

This file was deleted.

Loading

0 comments on commit 23e06bf

Please sign in to comment.