Skip to content
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.

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

Add MKdocs for Friendica doc #11702

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Open
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ robots.txt
/config/local.ini.php
/config/addon.ini.php

#ignore documentation, it should be newly built
/doc/api
/doc/cache

#ignore reports, should be generated with every build
report/

Expand Down Expand Up @@ -72,6 +68,9 @@ venv/
/addons
/addon

#ignore help directory
/help

#ignore base .htaccess
/.htaccess

Expand Down
70 changes: 70 additions & 0 deletions .woodpecker/.documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#depends_on:
# - phpunit
# - code_standards_check

# This prevents executing this pipeline at other servers than ci.friendi.ca
labels:
type: releaser
location: friendica

pipeline:
clone_friendica_help:
image: alpine/git
commands:
- git clone https://git.friendi.ca/nupplaPhil/help.git help
- cd help
- git checkout -b ${CI_COMMIT_BRANCH}
volumes:
- /etc/hosts:/etc/hosts
restore_cache:
image: meltwater/drone-cache:dev
settings:
backend: "filesystem"
restore: true
cache_key: "{{ .Repo.Name }}_php7.4_{{ arch }}_{{ os }}"
archive_format: "gzip"
mount:
- '.composer'
volumes:
- /tmp/drone-cache:/tmp/cache
composer_install:
image: friendicaci/php7.4:php7.4.18
commands:
- export COMPOSER_HOME=.composer
- ./bin/composer.phar validate
- ./bin/composer.phar install --no-dev --optimize-autoloader
volumes:
- /etc/hosts:/etc/hosts
update_makefiles:
image: friendicaci/php7.4:php7.4.18
commands:
- ./bin/console createdocumentation createMkDocs
create_documentation:
image: friendicaci/mkdocs
commands:
- rm -fr help/*
- mkdocs build -d help
commit:
image: alpine/git
secrets:
- source: help-username
target: help_username
- source: help-password
target: help_password
commands:
- cd help/
- git config --global user.email "robot@friendi.ca"
- git config --global user.name "Friendica Robot"
- git add .
- git commit -m "${CI_COMMIT_LINK}"
- git push https://$HELP_USERNAME:$HELP_PASSWORD@git.friendi.ca/nupplaPhil/help.git --all
volumes:
- /etc/hosts:/etc/hosts
publish:
image: alpine
commands:
- mkdir -p /tmp/friendica_docs/${CI_COMMIT_BRANCH}
- rm -fr /tmp/friendica_docs/${CI_COMMIT_BRANCH}/*
- cp -fr ./help/* /tmp/friendica_docs/${CI_COMMIT_BRANCH}/
volumes:
- docs:/tmp/friendica_docs
51 changes: 0 additions & 51 deletions doc/FAQ-admin.md

This file was deleted.

80 changes: 0 additions & 80 deletions doc/Home.md

This file was deleted.

10 changes: 0 additions & 10 deletions doc/KeyboardShortcuts.md

This file was deleted.

15 changes: 0 additions & 15 deletions doc/Quick-Start-andfinally.md

This file was deleted.

21 changes: 0 additions & 21 deletions doc/README.md

This file was deleted.

42 changes: 0 additions & 42 deletions doc/Text_comment.md

This file was deleted.

Loading