Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
  • Loading branch information
bigcat88 committed Aug 19, 2023
1 parent 910613c commit 632e1fb
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ answer newbie questions, and generally made NC-Py-API that much better:

Andrey Borysenko <andrey18106x@gmail.com>
Alexander Piskun <bigcat88@icloud.com>
CooperGerman <https://github.com/CooperGerman>
<Please alphabetize new entries>

A big THANK YOU goes to:
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img src="https://raw.githubusercontent.com/cloud-py-api/nc_py_api/docs/resources/logo_py_nc.png" alt="NcPyApi logo">
</p>

# Official Nextcloud Python Framework

[![Analysis & Coverage](https://github.com/cloud-py-api/nc_py_api/actions/workflows/analysis-coverage.yml/badge.svg)](https://github.com/cloud-py-api/nc_py_api/actions/workflows/analysis-coverage.yml)
Expand Down
7 changes: 4 additions & 3 deletions docs/NextcloudApp.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Writing a Nextcloud Application
===============================

This chapter assumes that you are already familiar with the concept of the AppEcosystem(to-do: link).
This chapter assumes that you are already familiar with the `concepts <https://cloud-py-api.github.io/app_ecosystem_v2/Concepts.html>`_ of the AppEcosystem.

As a first step, let's take a look at the structure of a basic Python application.

Expand Down Expand Up @@ -49,7 +49,7 @@ First register ``manual_install`` daemon:
php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
Then, launch your application. Since this is a manual deployment, it's your responsibility to set all the environment variables.
Then, launch your application. Since this is a manual deployment, it's your responsibility to set minimum of the environment variables.
Here they are:

* APP_ID - ID of the application.
Expand Down Expand Up @@ -87,7 +87,8 @@ Pack & Deploy
-------------

Before reading this chapter, please review the basic information about deployment
and the currently supported types of deployments in the AppEcosystem documentation: to-do.
and the currently supported types of
`deployments configurations <https://cloud-py-api.github.io/app_ecosystem_v2/DeployConfigurations.html>`_ in the AppEcosystem documentation.

to-do

Expand Down
Binary file added docs/resources/logo_py_nc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 632e1fb

Please sign in to comment.