egroupware/doc
nathan 52b48140fe Get widget extra documentation working
This allows <Class>.md beside <Class>.ts where we can add additional documentation such as examples
2024-01-05 09:52:09 -07:00
..
docker updated Dockerfile and build.sh to get NodeJS 20 for all architectures 2023-12-01 12:40:23 +02:00
etemplate2 Get widget extra documentation working 2024-01-05 09:52:09 -07:00
IDE Add README for IDE section 2017-09-15 10:51:45 +02:00
ldap fix 2 warnings about continue 2 2020-06-03 13:20:09 +02:00
mail move all tables to new api and update api to 16.1 2016-04-02 19:55:08 +00:00
REST-CalDAV-CardDAV fix wrong curl call for viewing email 2023-11-14 14:37:46 +02:00
rpm-build Changelog for 23.1.20231220 2023-12-20 10:53:25 +02:00
scripts Docs fixes 2023-12-08 09:05:33 -07:00
ad-migration.sh - if we have no RID but a SID, calculate the RID 2018-03-13 16:04:18 +01:00
add_et2_dtd.sh Update PUBLIC ID of etemplate2.dtd in all templates 2017-02-01 09:59:37 +01:00
check_namespace.php remove (not supported) parameters after #!/usr/bin/env php 2017-06-07 15:08:30 +02:00
check-metadata.php Check_MK check for SAML metadata existence and age 2020-11-05 13:37:56 +01:00
config2xet.php fix 2 warnings about continue 2 2020-06-03 13:20:09 +02:00
dovecot-mailbox-status-compare.php script to compare mailboxes, eg. after a mail migration 2018-07-29 12:34:41 +02:00
Entry change push update.drawio Diagram for entry change push update flow 2020-01-29 15:12:43 +01:00
Entry change push update.pdf Diagram for entry change push update flow 2020-01-29 15:12:43 +01:00
fix_api.php remove (not supported) parameters after #!/usr/bin/env php 2017-06-07 15:08:30 +02:00
fix_depricated.php fix with PHP 7.2 deprecated each( ) construct 2019-03-12 11:10:47 +01:00
fix-8.1-depricated-interfaces-return-vals.php fix CallbackIterator to return mixed, as it can be overwritten with a callback 2022-04-24 21:27:53 +02:00
import-mail-credentials.php script to import mail usernames and passwords and store it encrypted for the given mail-account (acc_id) 2023-11-13 17:21:21 +02:00
js2ts.php remove wrong boilerplate 2021-06-15 13:34:03 +02:00
lang_files.txt move non outdated parts for phpgwapi/doc to global doc directory 2016-04-07 07:20:03 +00:00
ldif2sql.php update jquery-ui to 1.12.1 2021-08-11 15:38:13 +02:00
LICENSE make the phpgw Version-0_9_16-branch HEAD 2003-08-28 14:31:11 +00:00
links-www.egroupware.org.txt List of links from EGroupware sources to www.egroupware.org website 2021-01-14 10:37:40 +02:00
php_syntax_check.sh suppress everything (not just PHP Deprecated) from vendor, as its up to the vendor to fix 2020-06-03 13:12:38 +02:00
phpunit_bootstrap.php use domain from phpunix.xml and output Apache error.log so diagnose PHP errors in requests 2020-03-05 11:23:58 +01:00
phpunit.xml Move all tests under api/src into api/tests 2017-10-23 13:09:25 +02:00
README-dirs-less-css move less/css readme to doc dir 2016-05-19 12:04:22 +02:00
README.md Write down how this works while I remember 2023-09-25 08:22:41 -06:00
test-cli.php remove (not supported) parameters after #!/usr/bin/env php 2017-06-07 15:08:30 +02:00
travis-ci-apache.conf try fixing not started Apache 2020-03-04 23:27:46 +01:00
UCS-SAML-SSO.md fix not working html 2023-06-09 16:37:58 +02:00

Notes on automatic documentation

This is a project in itself. Here's how the pieces fit together:

  • build:dev package script calls /doc/scripts/build.mjs which is responsible for calling the individual pieces. We pass files to the subprocesses, but options are set in a separate config file.
  • /doc/scripts/metadata.mjs extracts the component information using CEM, and stores it to /doc/dist/custom-elements.json
  • /doc/scripts/etemplate2/eleventy.config.cjs uses 11ty to build a documentation site, from the subdirectories in /doc/etemplate2, and stores it to /doc/dist/site

If a component doesn't show up, it's probably not in the manifest.