From 5363506e0636ca1ed92e9171d8d21ce3d3af9a29 Mon Sep 17 00:00:00 2001 From: Andrey Borysenko Date: Mon, 6 Jan 2025 18:40:22 +0200 Subject: [PATCH] chore: remove docs ci, update README Signed-off-by: Andrey Borysenko --- .github/workflows/docs-check.yml | 25 ----------------- .github/workflows/docs.yml | 46 -------------------------------- README.md | 21 +++------------ 3 files changed, 4 insertions(+), 88 deletions(-) delete mode 100644 .github/workflows/docs-check.yml delete mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml deleted file mode 100644 index 0bb0e5a7..00000000 --- a/.github/workflows/docs-check.yml +++ /dev/null @@ -1,25 +0,0 @@ -# SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors -# SPDX-License-Identifier: MIT -name: Docs check -on: - pull_request: - -permissions: - contents: read - -jobs: - build_docs: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - - name: Install Docs dependencies - run: python3 -m pip install -r docs/requirements.txt - - - name: Build and push Docs - run: | - make html SPHINXOPTS="-W" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 8fc0d030..00000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,46 +0,0 @@ -# SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors -# SPDX-License-Identifier: MIT -name: Docs -on: - push: - branches: [ main ] - paths: - - '.github/workflows/docs.yml' - - 'docs/**' - -permissions: - contents: read - -jobs: - build_push_docs: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - - name: Install Docs dependencies - run: python3 -m pip install -r docs/requirements.txt - - - name: Build and push Docs - run: | - export CHANGES_DATE=`date -d"@$(git log -1 --pretty=%ct)" --iso-8601=seconds` - make html - git config --global user.name bigcat88 - git config --global user.email "bigcat88@users.noreply.github.com" - docroot=`mktemp -d` - rsync -av "docs/_build/html/" "${docroot}/" - pushd "${docroot}" - git init - git remote add deploy "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" - git checkout -b gh-pages - touch .nojekyll - git add . - msg="Docs: commit ${GITHUB_SHA} made on ${CHANGES_DATE} from ${GITHUB_REF} by ${GITHUB_ACTOR}" - git commit -am "${msg}" - git push deploy gh-pages --force - popd - env: - GITHUB_TOKEN: ${{ secrets.TOKEN_DOCS }} diff --git a/README.md b/README.md index ca052755..216743a0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ [![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/app_api)](https://api.reuse.software/info/github.com/nextcloud/app_api) [![Tests - Deploy](https://github.com/nextcloud/app_api/actions/workflows/tests-deploy.yml/badge.svg)](https://github.com/nextcloud/app_api/actions/workflows/tests-deploy.yml) [![Tests](https://github.com/nextcloud/app_api/actions/workflows/tests.yml/badge.svg)](https://github.com/nextcloud/app_api/actions/workflows/tests.yml) -[![Docs](https://github.com/nextcloud/app_api/actions/workflows/docs.yml/badge.svg)](https://nextcloud.github.io/app_api/) ### Supercharge your Nextcloud with AppAPI and applications specifically designed for it. @@ -28,22 +27,10 @@ ## Documentation -- [List of External Applications](https://github.com/nextcloud/app_api/blob/main/APPS.md) -- [Documentation](https://nextcloud.github.io/app_api/) - - [Installation](https://nextcloud.github.io/app_api/Installation.html) - - [Creation of Deploy Daemon](https://nextcloud.github.io/app_api/CreationOfDeployDaemon.html) - - [Managing External Applications](https://nextcloud.github.io/app_api/ManagingExternalApplications.html) -- [Technical Details](https://nextcloud.github.io/app_api/tech_details/index.html) - - [Concepts](https://nextcloud.github.io/app_api/Concepts.html) - - [Api Scopes](https://nextcloud.github.io/app_api/tech_details/ApiScopes.html) - - [AppAPI Nextcloud APIs](https://nextcloud.github.io/app_api/tech_details/api/index.html) - - [Authentication](https://nextcloud.github.io/app_api/tech_details/Authentication.html) - - [Deployment](https://nextcloud.github.io/app_api/tech_details/Deployment.html) -- [Contribute](https://github.com/nextcloud/app_api/blob/main/.github/CONTRIBUTING.md) - - [Discussions](https://github.com/nextcloud/app_api/discussions) - - [Issues](https://github.com/nextcloud/app_api/issues) - - [Setting up dev environment](https://nextcloud.github.io/app_api/DevSetup.html) -- [Changelog](https://github.com/nextcloud/app_api/blob/main/CHANGELOG.md) +Latest documentation can be found here: + +1. Admin manual: [ExApps management](https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/index.html) +2. Developer manual: [ExApp development](https://docs.nextcloud.com/server/latest/developer_manual/exapp_development/index.html) ### Support