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

Move Zakim and RRSAgent docs to the Guidebook and migrate them to Markdown #302

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

vivienlacourba
Copy link
Member

@vivienlacourba vivienlacourba commented Jan 23, 2025

@vivienlacourba vivienlacourba requested a review from deniak January 23, 2025 10:49
@vivienlacourba vivienlacourba self-assigned this Jan 23, 2025
index.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/zakim.md Outdated Show resolved Hide resolved
@deniak
Copy link
Member

deniak commented Jan 23, 2025

To limit the TOC level on the zakim page, we would need to use a different _config.yml as this is the only place the jekyll-toc plugin can be configured.
The idea would be to introduced a copy of _config.yml, e.g. _config-zakim.yml, and just change the toc.max_level.
This way, we could run the generation a first time with a lower TOC level:

bundle exec jekyll build --config _config-zakim.yml

then, in _config.yml, we would need to skip the generation of the zakim document:

exclude: ["README.md", "**/README.md", "meetings/zakim.md"]
keep_files: ["meetings/zakim.html"]

Finally, when you regenerate the whole site, it'll keep the previous version of the zakim document.

bundle exec jekyll build

@vivienlacourba vivienlacourba marked this pull request as ready for review January 23, 2025 12:53
@vivienlacourba
Copy link
Member Author

vivienlacourba commented Jan 23, 2025

To limit the TOC level on the zakim page, we would need to use a different _config.yml as this is the only place the jekyll-toc plugin can be configured. The idea would be to introduced a copy of _config.yml, e.g. _config-zakim.yml, and just change the toc.max_level. This way, we could run the generation a first time with a lower TOC level:

bundle exec jekyll build --config _config-zakim.yml

then, in _config.yml, we would need to skip the generation of the zakim document:

exclude: ["README.md", "**/README.md", "meetings/zakim.md"]
keep_files: ["meetings/zakim.html"]

Finally, when you regenerate the whole site, it'll keep the previous version of the zakim document.

bundle exec jekyll build

Discussing with @deniak, this solution seems too complex.

As a workaround we used CSS to hide secondary headings, see commit 3a77a53.

A proper solution would be to add this option to the jekyll-toc plugin or switch to another plugin, as this feature which was requested by several people:

@vivienlacourba vivienlacourba requested a review from swickr January 23, 2025 12:57
Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prettification, punctuation fixes, etc.

meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/rrsagent.md Outdated Show resolved Hide resolved
meetings/zakim.md Outdated Show resolved Hide resolved
@vivienlacourba vivienlacourba force-pushed the zakim-rrsagent-docs branch 2 times, most recently from 3f0e2fe to 95ede0b Compare January 24, 2025 09:34
Co-authored-by: Ted Thibodeau Jr <[email protected]>
Co-authored-by: Vivien Lacourba <[email protected]>
Comment on lines +93 to +98
- `rrsagent, grep [-i] [first-last|max] <text>`
- `rrsagent, search for [-i] [first-last|max] <text>`
- `rrsagent, find [-i] [first-last|max] <text>`
- `rrsagent, <text>?`

Searches the log for `<text>`. The text is interpreted as a perl regex; e.g., '`.`' matches any character, '`<char>+`' matches one or more consecutive occurrences of `<char>`, and '`<char>*`' matches any number of consecutive occurrences of `<char>`, etc. '`-i`' causes the comparison to be case insensitive. '`first`', '`last`', and '`max`' limit the reported results to the specified (first and last) results or to at most (max) results.
Copy link
Member Author

@vivienlacourba vivienlacourba Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@swickr I first thought that first-last was a typo instead of first|last (first or last), but testing the RRSAgent search command I could not get any of those combinations working.

See my tests in: https://www.w3.org/2025/01/24-vivtest-irc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants