summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
2023-08-14doc: Add cgit setup how to.•••* 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. Arun Isaac
2023-08-12doc: Clarify that README files for cgit must be in the default branch.•••* doc/forge.skb (Services)[Git web viewers]{cgit service}: Clarify that README files are looked up in the default branch. Arun Isaac
2023-08-12doc: Spell viewer correctly.•••* doc/forge.skb (Services)[Git web viewers]: Spell viewer correctly. Arun Isaac
2023-08-12cgit: Render org mode README files.•••* 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. Arun Isaac
2023-08-10doc: Move gunicorn service documentation to Services chapter.•••* doc/forge.skb (Reference): Move gunicorn service documentation to ... (Services)[Specialized application deployment services]{gunicorn service}: ... new subsection. Arun Isaac
2023-08-10doc: Capitalize HTML.•••* doc/forge.skb (Services)[Git web viewers]{cgit service}: Capitalize HTML. Arun Isaac
2023-08-10doc: Distinguish cgit service from upstream cgit service.•••* doc/forge.skb (Services)[Git web viewers]{cgit service}: Distinguish from upstream cgit service. Arun Isaac
2023-08-10doc: Mention reStructuredText as a supported README file in cgit.•••* doc/forge.skb (Services)[Git web viewers]{cgit service}: Mention reStructuredText as a supported README file. Arun Isaac
2023-08-10doc: Fix spelling cloneable -> clonable.•••* doc/forge.skb (Services)[Git web viewers]{cgit service}: Fix spelling cloneable -> clonable. Arun Isaac
2023-08-09doc: List subsections in table of contents.•••* doc/forge.skb: List subsections in table of contents. Arun Isaac
2023-08-09doc: Remove trailing period at end of phrase.•••* doc/forge.skb (Reference)[gunicorn-app]: Remove trailing period at the end of mappings documentation phrase. Arun Isaac
2023-08-09gunicorn: Support <forge-host-socket> sockets.•••* guix/forge/gunicorn.scm (socket->gunicorn-bind): Support <forge-host-socket> sockets. * doc/forge.skb (Reference): Document it. Arun Isaac
2023-08-09doc: Set identifier on item markup in record documentation.•••* doc/skribilo.scm (record-documentation): Set identifier on item markup instead of using a separate mark. Arun Isaac
2023-08-09cgit: Add cgit service.•••* guix/forge/cgit.scm: New file. * doc/forge.skb (Services)[Git web viewers]: New section. Arun Isaac
2023-08-09fcgiwrap: Add fcgiwrap service.•••* guix/forge/fcgiwrap.scm: New file. * doc/forge.skb (Services)[Specialized application deployment services]: New section. Arun Isaac
2023-08-09nginx: Add forge-nginx service.•••* 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. Arun Isaac
2023-08-09doc: Space elements of S-expression in quoted-write.•••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. Arun Isaac
2023-08-09acme: Add ACME service.•••* 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. Arun Isaac
2023-08-09doc: Add record-ref convenience function.•••* doc/skribilo.scm (record-ref): New public function. * doc/forge.skb: Use record-ref. Arun Isaac
2023-08-09doc: Override description markup writer.•••* doc/skribilo.scm: Import (skribilo output). (node->html-tag): New function. (html-engine): Override the description markup writer. Arun Isaac
2023-08-09doc: Re-indent abbr markup writer.•••* doc/skribilo.scm (html-engine): Re-indent. Arun Isaac
2023-08-08socket: Introduce <forge-host-socket>.•••* guix/forge/socket.scm (<forge-host-socket>): New record type. * doc/forge.skb (Reference): Document <forge-host-socket>. Arun Isaac
2023-07-25klaus: Add helper function to create klaus gunicorn app.•••* 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. Arun Isaac
2023-07-25doc: Add docstring-function-documentation.•••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. Arun Isaac
2023-07-25doc: Add quoted-write.•••* doc/skribilo.scm (quoted-write): New function. (expression->string): Rewrite in terms of quoted-write. Arun Isaac
2023-07-25gunicorn: Add gunicorn service.•••* guix/forge/gunicorn.scm: New file. * doc/forge.skb (Reference): Document <gunicorn-configuration> and <gunicorn-app>. Arun Isaac
2023-03-09doc: Explain with-imported-modules and use-modules.•••* doc/forge.skb (Tutorial): Explain why both with-imported-modules and use-modules are necessary. Arun Isaac
2023-02-03doc: Identify chapters.•••* doc/forge.skb: Identify each chapter with a unique identifier. Arun Isaac
2022-10-17webhook: Use <forge-*-socket> to configure socket.•••* 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. Arun Isaac
2022-07-05socket: Introduce <forge-*-socket> types.•••<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>. Arun Isaac
2022-06-01doc: Label file as post-receive, instead of post-receive-hook.•••* doc/forge.skb (Tutorial, Reference): Label file as post-receive, instead of post-receive-hook. Arun Isaac
2022-06-01doc: Move comma displaced by Emacs lispy-mode.•••* doc/forge.skb (Reference): Move comma displaced by Emacs lispy mode. Arun Isaac
2022-04-08doc: Link to ci-jobs-trigger-gexp definition.•••* doc/forge.skb (Tutorial): Link mention of post-receive-hook script to the in-source definition of ci-jobs-trigger-gexp. Arun Isaac
2022-04-08doc: Create dummy G-expression reader.•••* doc/skribilo.scm: Extend the reader with a dummy G-expression reader. Arun Isaac
2022-03-28forge: Add trigger? field to forge-laminar-job.•••* 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?. Arun Isaac
2022-03-21doc: Explain what a post-receive-hook is and how it is set up.•••* doc/forge.skb (Tutorial): Explain what a post-receive-hook is and how it is set up. Arun Isaac
2022-03-21doc: Clarify double reference of (guix build utils).•••* doc/forge.skb (Tutorial): Clarify double reference of (guix build utils). Arun Isaac
2022-03-20doc: Link to G-expressions in the Guix manual.•••* doc/forge.skb (Tutorial): Link to G-expressions in the Guix manual. Arun Isaac
2022-03-19doc: Mention minimum configurability to philosophy.•••* README.org (Philosophy), doc/forge.skb (Introduction)[Philosophy]: Mention minimum configurability. Arun Isaac
2022-03-19doc: List software components used by guix-forge.•••* README.org, doc/forge.skb (Introduction): List software components used by guix-forge. Arun Isaac
2022-03-19forge: Change ownership of parent directory of website directory.•••* 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. Arun Isaac
2022-03-08doc: Reference source files inside guix directory.•••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. Arun Isaac
2022-02-28doc: Add Tutorial.•••* 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. Arun Isaac
2022-02-28doc: Add table of contents.•••* doc/forge.skb: Add table of contents. Arun Isaac
2022-02-28forge: Clone the default branch, not any specific branch.•••* 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. Arun Isaac
2022-02-28doc: Add Reference chapter.•••* doc/forge.skb (Reference): New chapter. Arun Isaac
2022-02-28doc: Add reference documentation machinery.•••* 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. Arun Isaac
2022-02-28doc: Add manual.•••* Makefile (GUILD, SKRIBILO, sources, doc_skribilo_config, doc_skribilo_config_go, doc_sources, doc_html): New variables. (%.go, html, $(doc_html), website/manual/dev/en, clean): New targets. (website): Depend on website/manual/dev/en. (.PHONY): Add html and clean targets. * doc/forge.skb, doc/skribilo.scm: New files. Arun Isaac
generated by cgit v1.2.3 (git 2.47.1) at 2025-02-16 23:27:54 +0000