mirror of
https://github.com/nextcloud/app_api.git
synced 2025-07-22 01:13:11 +00:00
chore: remove docs ci, update README (#484)
AppAPI docs are now moved to Nextcloud documentation, removing not needed anymore docs CI, update README. --------- Signed-off-by: Andrey Borysenko <andrey18106x@gmail.com>
This commit is contained in:
25
.github/workflows/docs-check.yml
vendored
25
.github/workflows/docs-check.yml
vendored
@ -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"
|
46
.github/workflows/docs.yml
vendored
46
.github/workflows/docs.yml
vendored
@ -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 }}
|
26
README.md
26
README.md
@ -7,7 +7,6 @@
|
||||
[](https://api.reuse.software/info/github.com/nextcloud/app_api)
|
||||
[](https://github.com/nextcloud/app_api/actions/workflows/tests-deploy.yml)
|
||||
[](https://github.com/nextcloud/app_api/actions/workflows/tests.yml)
|
||||
[](https://nextcloud.github.io/app_api/)
|
||||
|
||||
### Supercharge your Nextcloud with AppAPI and applications specifically designed for it.
|
||||
|
||||
@ -16,10 +15,9 @@
|
||||
1. **Enhanced stability** This ecosystem is committed to maintaining API stability over extended periods.
|
||||
This ensures a reliable and consistent user experience as developers won't need to constantly update their apps with each new release.
|
||||
|
||||
2. **Enhanced security.** Unlike the traditional method, which allowed direct interaction with the core Nextcloud code,
|
||||
this approach emphasizes more specialized API scopes, resulting in greater application stability and a more focused user experience.
|
||||
2. **Enhanced security** Unlike the traditional method, which allowed direct interaction with the core Nextcloud code, this approach uses controlled APIs to manage access, ensuring greater application stability and delivering a more focused user experience.
|
||||
|
||||
3. **Reliable computing power.** The ecosystem is designed to solve resource-intensive problems.
|
||||
3. **Reliable computing power** The ecosystem is designed to solve resource-intensive problems.
|
||||
Developers can easily integrate complex computing functions, including advanced machine learning models, and run them on external hardware.
|
||||
|
||||
4. **Community friendly** The project aims to attract a diverse and broader developer community by creating applications
|
||||
@ -28,22 +26,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
|
||||
|
||||
|
Reference in New Issue
Block a user