Bug 268764 - fdp-primer: code block updates
Summary: fdp-primer: code block updates
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Sergio Carlavilla Delgado
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-01-05 09:07 UTC by Jethro Nederhof
Modified: 2023-01-08 14:02 UTC (History)
2 users (show)

See Also:


Attachments
8 patch files described above (5.12 KB, application/gzip)
2023-01-05 09:07 UTC, Jethro Nederhof
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jethro Nederhof 2023-01-05 09:07:06 UTC
Created attachment 239275 [details]
8 patch files described above

Hoping to make some contributions to the documentation so started with reading the FDP guide.

Found a few issues, have broken the patches up and they're mostly pretty tiny so hopefully this one PR is OK.

1: Fixes a few AsciiDoc syntax issues I noticed
2: Note that you may already have vale installed if you installed docproj as it is already a dependency of that metaport
3: Add some source lang tags to a bunch of code blocks
4: Add some descriptive links to the Emacs config section, and fix the sample XML provided
5: Some small punctuation/grammar tweaks
6: Should fix #268238
7: Show the language when you hover over a code snippet, similar to the official AsciiDoctor documentation
8: Small tweaks to the display of titles for code snippets (as introduced in patch 3)
Comment 1 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-01-05 09:10:01 UTC
I'll take this.
Comment 2 Muhammad Moinur Rahman freebsd_committer freebsd_triage 2023-01-05 09:44:03 UTC
I have a working Emacs configuration which I will submit for review soon.
Comment 3 commit-hook freebsd_committer freebsd_triage 2023-01-08 14:01:27 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=64328973c9c005699fbfa7ae776486d24d00f5f0

commit 64328973c9c005699fbfa7ae776486d24d00f5f0
Author:     Jethro Nederhof <jethro@jethron.id.au>
AuthorDate: 2023-01-08 13:57:23 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-01-08 14:00:40 +0000

    Changes in FDP primer

    * Minor grammar tweaks
    * Improvements in AsciiDoc syntax
    * Improvements in css code blocks
    * Display language on hover in code blocks
    * Use console instead shell in some code blocks[1]
    * Add link for Flycheck

    PR: 268764

    [1] https://docs.asciidoctor.org/asciidoc/latest/verbatim/source-highlighter/#shell-vs-console

 .../en/books/fdp-primer/editor-config/_index.adoc  | 50 ++++++++++++++--------
 .../en/books/fdp-primer/structure/_index.adoc      | 10 ++---
 .../en/books/fdp-primer/writing-style/_index.adoc  |  2 +-
 .../themes/beastie/assets/styles/global.scss       | 18 ++++++--
 4 files changed, 52 insertions(+), 28 deletions(-)
Comment 4 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-01-08 14:02:11 UTC
Merged. Thanks for all the changes.
Hope to see changes like that in the future!
Thanks!!