summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-08-15doc: Advertise support for cgit and klaus.Arun Isaac
* doc/forge.skb (Introduction), website/index.skb: Advertise support for cgit and klaus.
2023-08-15doc: Remind about the ACME state directory in persistent storage.Arun Isaac
* doc/forge.skb (How To)[How to set up cgit]: Remind about putting the ACME state directory in persistent storage.
2023-08-14doc: Mention that cgit runs in a container in how to.Arun Isaac
* doc/forge.skb (How To)[How to set up cgit]: Mention that cgit runs in a container.
2023-08-14doc: Add cgit setup how to.Arun Isaac
* doc/forge.skb (How To): New chapter. * doc/snippets/acme-staging-url.scm, doc/snippets/how-to-set-up-cgit.scm: New files. * tissue.scm (#:indexed-documents): Index chapter-how-to.
2023-08-12doc: Clarify that README files for cgit must be in the default branch.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Clarify that README files are looked up in the default branch.
2023-08-12doc: Spell viewer correctly.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]: Spell viewer correctly.
2023-08-12cgit: Render org mode README files.Arun Isaac
* guix/forge/cgit.scm: Import emacs-minimal from (gnu packages emacs). (%cgit-readme): Add README.org. (about-filter-gexp): Render org mode README files. * guix/forge/org2html.el: New file. * doc/forge.skb (Services)[Git web viewers]{cgit service}: Document support for org mode README files.
2023-08-10doc: Move gunicorn service documentation to Services chapter.Arun Isaac
* doc/forge.skb (Reference): Move gunicorn service documentation to ... (Services)[Specialized application deployment services]{gunicorn service}: ... new subsection.
2023-08-10doc: Capitalize HTML.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Capitalize HTML.
2023-08-10doc: Distinguish cgit service from upstream cgit service.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Distinguish from upstream cgit service.
2023-08-10doc: Mention reStructuredText as a supported README file in cgit.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Mention reStructuredText as a supported README file.
2023-08-10doc: Fix spelling cloneable -> clonable.Arun Isaac
* doc/forge.skb (Services)[Git web viewers]{cgit service}: Fix spelling cloneable -> clonable.
2023-08-09doc: List subsections in table of contents.Arun Isaac
* doc/forge.skb: List subsections in table of contents.
2023-08-09doc: Remove trailing period at end of phrase.Arun Isaac
* doc/forge.skb (Reference)[gunicorn-app]: Remove trailing period at the end of mappings documentation phrase.
2023-08-09gunicorn: Support <forge-host-socket> sockets.Arun Isaac
* guix/forge/gunicorn.scm (socket->gunicorn-bind): Support <forge-host-socket> sockets. * doc/forge.skb (Reference): Document it.
2023-08-09doc: Set identifier on item markup in record documentation.Arun Isaac
* doc/skribilo.scm (record-documentation): Set identifier on item markup instead of using a separate mark.
2023-08-09cgit: Add cgit service.Arun Isaac
* guix/forge/cgit.scm: New file. * doc/forge.skb (Services)[Git web viewers]: New section.
2023-08-09fcgiwrap: Add fcgiwrap service.Arun Isaac
* guix/forge/fcgiwrap.scm: New file. * doc/forge.skb (Services)[Specialized application deployment services]: New section.
2023-08-09nginx: Add forge-nginx service.Arun Isaac
* guix/forge/nginx.scm, doc/snippets/acme-restart-nginx-sudoers.scm: New files. * doc/forge.skb (Services)[forge nginx service]: Document the forge-nginx service.
2023-08-09doc: Space elements of S-expression in quoted-write.Arun Isaac
Prior to this, an expression such as (list 1 2 3) would be printed as (list 123). * doc/skribilo.scm (quoted-write): Add space between elements of S-expression.
2023-08-09acme: Add ACME service.Arun Isaac
* guix/forge/acme.scm: Import shadow from (gnu packages admin), nss-certs from (gnu packages certs), (gnu services), (gnu services mcron), (gnu system shadow), (guix diagnostics), (guix i18n), (guix profiles), (guix records), (srfi srfi-1) and (ice-9 match). (%letsencrypt-production-url, %letsencrypt-staging-url): New variables. (<acme-configuration>, <acme-rsa-key>, <acme-ecdsa-key>, <acme-certificate>): New record types. (acme-http-01-webroot-authorization-hook, acme-http-01-webroot-cleanup-hook): New public functions. (acme-key-length, uacme-hook, acme-activation, acme-renew, acme-helper, acme-helper-sudo-wrapper, acme-special-files, acme-cron-job, raise-to-top): New functions. (%acme-accounts, acme-service-type): New variables. * doc/forge.skb (Services)[ACME service]: New section.
2023-08-09doc: Add record-ref convenience function.Arun Isaac
* doc/skribilo.scm (record-ref): New public function. * doc/forge.skb: Use record-ref.
2023-08-09doc: Override description markup writer.Arun Isaac
* doc/skribilo.scm: Import (skribilo output). (node->html-tag): New function. (html-engine): Override the description markup writer.
2023-08-09doc: Re-indent abbr markup writer.Arun Isaac
* doc/skribilo.scm (html-engine): Re-indent.
2023-08-08socket: Introduce <forge-host-socket>.Arun Isaac
* guix/forge/socket.scm (<forge-host-socket>): New record type. * doc/forge.skb (Reference): Document <forge-host-socket>.
2023-07-25klaus: Add helper function to create klaus gunicorn app.Arun Isaac
* guix/forge/klaus.scm: Import (forge gunicorn) and (gnu system file-systems). (klaus-gunicorn-app): New public function. * doc/forge.skb (Introduction): Advertise klaus support. (Reference): Document klaus-gunicorn-app.
2023-07-25doc: Add docstring-function-documentation.Arun Isaac
docstring-function-documentation lets us generate function documentation from the docstrings of functions. * doc/skribilo.scm: Import (texinfo). (<function>): New record type. (find-function-definition, stexi->skribe): New functions. (docstring-function-documentation): New public function.
2023-07-25doc: Add quoted-write.Arun Isaac
* doc/skribilo.scm (quoted-write): New function. (expression->string): Rewrite in terms of quoted-write.
2023-07-25gunicorn: Add gunicorn service.Arun Isaac
* guix/forge/gunicorn.scm: New file. * doc/forge.skb (Reference): Document <gunicorn-configuration> and <gunicorn-app>.
2023-03-09doc: Explain with-imported-modules and use-modules.Arun Isaac
* doc/forge.skb (Tutorial): Explain why both with-imported-modules and use-modules are necessary.
2023-02-03doc: Identify chapters.Arun Isaac
* doc/forge.skb: Identify each chapter with a unique identifier.
2022-10-17webhook: Use <forge-*-socket> to configure socket.Arun Isaac
* doc/forge.skb (Reference)[<webhook-configuration>]: Replace ip and port fields with the socket field. * guix/forge/webhook.scm: Import (forge socket). (<webhook-configuration>): Replace ip and port fields with the socket field. (webhook-shepherd-service): Reference the socket field instead of the ip and port fields.
2022-07-05socket: Introduce <forge-*-socket> types.Arun Isaac
<forge-*-socket> will be a universal type to specify IP addresses, ports and Unix sockets across all guix-forge services. * guix/forge/socket.scm: New file. * doc/forge.skb (Reference): Document <forge-ip-socket> and <forge-unix-socket>.
2022-06-01doc: Label file as post-receive, instead of post-receive-hook.Arun Isaac
* doc/forge.skb (Tutorial, Reference): Label file as post-receive, instead of post-receive-hook.
2022-06-01doc: Move comma displaced by Emacs lispy-mode.Arun Isaac
* doc/forge.skb (Reference): Move comma displaced by Emacs lispy mode.
2022-04-08doc: Link to ci-jobs-trigger-gexp definition.Arun Isaac
* doc/forge.skb (Tutorial): Link mention of post-receive-hook script to the in-source definition of ci-jobs-trigger-gexp.
2022-04-08doc: Create dummy G-expression reader.Arun Isaac
* doc/skribilo.scm: Extend the reader with a dummy G-expression reader.
2022-03-28forge: Add trigger? field to forge-laminar-job.Arun Isaac
* guix/forge/laminar.scm (<forge-laminar-job>)[trigger?]: New field. * guix/forge/forge.scm (ci-jobs-trigger-gexp): Only trigger jobs for which trigger? is #t. * doc/forge.skb (Reference)[<forge-laminar-job>]: Document trigger?.
2022-03-21doc: Explain what a post-receive-hook is and how it is set up.Arun Isaac
* doc/forge.skb (Tutorial): Explain what a post-receive-hook is and how it is set up.
2022-03-21doc: Clarify double reference of (guix build utils).Arun Isaac
* doc/forge.skb (Tutorial): Clarify double reference of (guix build utils).
2022-03-20doc: Link to G-expressions in the Guix manual.Arun Isaac
* doc/forge.skb (Tutorial): Link to G-expressions in the Guix manual.
2022-03-19doc: Mention minimum configurability to philosophy.Arun Isaac
* README.org (Philosophy), doc/forge.skb (Introduction)[Philosophy]: Mention minimum configurability.
2022-03-19doc: List software components used by guix-forge.Arun Isaac
* README.org, doc/forge.skb (Introduction): List software components used by guix-forge.
2022-03-19forge: Change ownership of parent directory of website directory.Arun Isaac
* guix/forge/forge.scm (forge-activation): Change ownership of parent directory of website directory, instead of changing the ownership of the website directory itself. * doc/forge.skb (Reference)[<forge-project>]: Document it.
2022-03-08doc: Reference source files inside guix directory.Arun Isaac
The source files are now nested one level deeper in the guix directory, and the references to the source files in the documentation need to be updated. * doc/forge.skb (Reference): Reference source files inside guix directory.
2022-02-28doc: Add Tutorial.Arun Isaac
* Makefile (doc_snippets): New variable. ($(doc_html)): Depend on $(doc_snippets). * doc/forge.skb: Import (skribilo source lisp). (Tutorial): New chapter. * doc/snippets/tutorial.scm: New file.
2022-02-28doc: Add table of contents.Arun Isaac
* doc/forge.skb: Add table of contents.
2022-02-28forge: Clone the default branch, not any specific branch.Arun Isaac
* forge/build/git.scm (download-git-to-store): Demote branch to optional keyword argument. * forge/forge.scm (derivation-job-gexp): Do not pass the branch argument to download-git-to-store. * doc/forge.skb (Reference)[<forge-project>]: Document that the repository-branch field is unused.
2022-02-28doc: Add Reference chapter.Arun Isaac
* doc/forge.skb (Reference): New chapter.
2022-02-28doc: Add reference documentation machinery.Arun Isaac
* doc/skribilo.scm: Import (srfi srfi-1), (srfi srfi-9), (srfi srfi-26) and (srfi srfi-171). (<record>, <no-default>, <record-field>): New record types. (field-sexp->record-field, record-sexp->record, find-record-definition, expression->string): New functions. (record-documentation, record-field): New public functions.
generated by cgit v1.2.3 (git 2.45.2) at 2024-11-27 02:38:47 +0000