Skip to content

fix: update script and readme #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmattel merged 1 commit into from
May 19, 2026
Merged

fix: update script and readme #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# ownCloud config sample to AsciiDoc converter

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c5e375e4b4af47238dcb8fc234960da4)](https://www.codacy.com/app/settermjd/ownCloud-config-converter?utm_source=github.com&utm_medium=referral&utm_content=settermjd/ownCloud-config-converter&utm_campaign=Badge_Grade)

Both, `config.sample.php` and `config.apps.sample.php` have their home in core and are written as pure php samples. To use these samples for the owncloud documentation, you need to convert them to an `.adoc` file usable in docs. This repo supports the conversion to an .adoc file by providing an automatism for this process.

**Note:** It is necessary to run this command always for both files `config.sample.php` and `config.apps.sampe.php`
Expand Down Expand Up @@ -33,7 +31,7 @@ Currently this relies on the following rules

## General Command

The command has the following structure.
The internal conversion command has the following structure.

```
convert.php [options] [arguments]
Expand All @@ -45,9 +43,9 @@ For a detailed list of arguments and options, use `--help`.

To ease the conversion process, the following steps / prerequisites should be taken:

* You have cloned `core`, `docs` and the `config-to-docs` repo locally, into the same base directory
* You have cloned `core`, `docs-server` and the `config-to-docs` repo locally, into the same base directory
* `core`: the master branch should be checked out, containing the latest merged sample files
* `docs`: you have created a new branch based on an updated master, this branch will contain all changes that will be pushed to docs
* `docs-server`: you have created a new branch based on an updated master, this branch will contain all changes that will be pushed to docs
* `config-to-docs`: you have changed into the root of this directory and are ready to run the commands

Use the following commands for each sample file, or the prepared script `./ctd.sh` which runs both commands below and reminds you about the prerequisites.
Expand Down
2 changes: 1 addition & 1 deletion ctd.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ printf "\nThis script assumes that you have the git clone directory of core and
printf "\nPlease ensure before running this script, that you have switched to the correct branch in core AND you have created and switched to a pushable target branch in docs !!\n\n"

CORE="../core"
DOCS="../docs"
DOCS="../docs-server"

if [ ! -d "$CORE" ]; then
printf "\ncore repo not found - exiting\n"
Expand Down