Re: CfEngine vs bash scripts
On Fri, May 12, 2023 at 1:34 PM Holger Levsen wrote: > > not telling you what to do, but IMNSHO someone with time should look > into > https://wiki.debian.org/DebianEdu/Status/Bookworm#Known_problems_that_need_to_be_fixed > else we don't have Debian Edu / Skolelinux in bookworm. > You are certainly right, from your point of view. But I lack the motivation to work on these tasks, even if I had time. Besides, I think that these tasks are difficult for a beginner (who is not familiar with all the services and their configuration details). Kind regards, Dashamir
Re: User Docs for DebianEdu
On Fri, May 12, 2023 at 1:11 PM Petter Reinholdtsen wrote: > > While it is unclear to me if it is a good idea to leave the Debian wiki > when writing documentation, I leave that to others to figure out. > I leave that to others too. I just wanted to point out that when selecting source format for the > documentation, I strongly recommend using a format that can be converted > to docobok using pandoc, to be able to create good looking documentation > in both HTML, PDF and ePub format. > > It is also a very good idea to ensure the format selected is well > handled by po4a to allow the documents to be translated into non-English > > Personally I would recommend Restructured text (rst) over markdown, as > it has a richer vocabulary than markdown. I recommend Restructured text > over Asciidoc as the latter is less well supported by po4a. > My first choice would be AsciiDoc+Antora because I have some experience with them. I think that the AsciiDoc syntax provides the best mapping to the DocBook features. Pandoc cannot handle it well precisely because its structure is richer than what pandoc can support. But we can use Asciidoctor instead to generate DocBook from AsciiDoc: https://docs.asciidoctor.org/asciidoctor/latest/docbook-backend/ I have not really explored po4a (and if you ask me it is a bad approach to translation), but it seems like it is supported: https://gitlab.com/antora-ui-custom/antora-i18n#user-content-po4a Cannot say whether this support is better or worse compared to Restructured text. Kind regards, Dashamir
RE: User Docs for DebianEdu
Date: Fri, 12 May 2023 11:35:01 + From: Holger Levsen To: debian-edu@lists.debian.org > It's not the lockdown which is unbearable, but the virus. Whilst it is off-topic, I think that statement, from Holger's signature, is very well put. .. Bret Busby Armadale West Australia (UTC+0800) ..
Re: User Docs for DebianEdu
On Fri, May 12, 2023 at 01:11:07PM +0200, Petter Reinholdtsen wrote: > While it is unclear to me if it is a good idea to leave the Debian wiki > when writing documentation, I leave that to others to figure out. I also very much doubt this... > I just wanted to point out that when selecting source format for the > documentation, I strongly recommend using a format that can be converted > to docobok using pandoc, to be able to create good looking documentation > in both HTML, PDF and ePub format. > > It is also a very good idea to ensure the format selected is well > handled by po4a to allow the documents to be translated into non-English > languages using the tools currently used by translators YES -- cheers, Holger ⢀⣴⠾⠻⢶⣦⠀ ⣾⠁⢠⠒⠀⣿⡁ holger@(debian|reproducible-builds|layer-acht).org ⢿⡄⠘⠷⠚⠋⠀ OpenPGP: B8BF54137B09D35CF026FE9D 091AB856069AAA1C ⠈⠳⣄ It's not the lockdown which is unbearable, but the virus. signature.asc Description: PGP signature
Re: CfEngine vs bash scripts
On Fri, May 12, 2023 at 01:18:04PM +0200, Dashamir Hoxha wrote: > I don't understand the benefits of using cfengine instead of bash scripts > in debian-edu-config. I believe that all the needed configurations can be > done with bash scripts. > > I am not familiar with cfengine, but I assume that it is similar to > ansible, which I am familiar with a little bit. They are made to automate > the installation (and configuration) of hundreds of servers from a single > place. But when there is only one server to configure and maintain, bash > scripts are much better. cfengine in debian-edu-config is used to support multiple different system types. > Have you ever thought about converting the cfengine scripts to bash > scripts? If this seems like an improvement, I can have a look at it (when I > find time). I do have some good experience with using bash scripts for > server configuration. not telling you what to do, but IMNSHO someone with time should look into https://wiki.debian.org/DebianEdu/Status/Bookworm#Known_problems_that_need_to_be_fixed else we don't have Debian Edu / Skolelinux in bookworm. -- cheers, Holger ⢀⣴⠾⠻⢶⣦⠀ ⣾⠁⢠⠒⠀⣿⡁ holger@(debian|reproducible-builds|layer-acht).org ⢿⡄⠘⠷⠚⠋⠀ OpenPGP: B8BF54137B09D35CF026FE9D 091AB856069AAA1C ⠈⠳⣄ Das Leben ist schön. Von 'einfach' war nie die Rede. (@lernzyklus) signature.asc Description: PGP signature
CfEngine vs bash scripts
Hi, I don't understand the benefits of using cfengine instead of bash scripts in debian-edu-config. I believe that all the needed configurations can be done with bash scripts. I am not familiar with cfengine, but I assume that it is similar to ansible, which I am familiar with a little bit. They are made to automate the installation (and configuration) of hundreds of servers from a single place. But when there is only one server to configure and maintain, bash scripts are much better. Some of the advantages of bash scripts would be: - They are more powerful and flexible. - Bash is ubiquitous (it is available everywhere), no need for extra dependencies. - Bash scripts are much more popular than cfengine (or ansible). The number of people who can understand, customize and contribute to bash scripts is much higher than those who can do the same thing with cfengine. Have you ever thought about converting the cfengine scripts to bash scripts? If this seems like an improvement, I can have a look at it (when I find time). I do have some good experience with using bash scripts for server configuration. Kind regards, Dashamir
Re: User Docs for DebianEdu
While it is unclear to me if it is a good idea to leave the Debian wiki when writing documentation, I leave that to others to figure out. I just wanted to point out that when selecting source format for the documentation, I strongly recommend using a format that can be converted to docobok using pandoc, to be able to create good looking documentation in both HTML, PDF and ePub format. It is also a very good idea to ensure the format selected is well handled by po4a to allow the documents to be translated into non-English languages using the tools currently used by translators of both the Debian Edu documentation and free software, ref https://people.skolelinux.org/pere/blog/From_English_wiki_to_translated_PDF_and_epub_via_Docbook.html >. Note, since the blog post was written, we started using Hosted Weblate to handle most translations, see https://hosted.weblate.org/projects/debian-edu-documentation/ > for the current status. Personally I would recommend Restructured text (rst) over markdown, as it has a richer vocabulary than markdown. I recommend Restructured text over Asciidoc as the latter is less well supported by po4a. -- Happy hacking Petter Reinholdtsen
User Docs for DebianEdu
Hi, On Fri, Mar 31, 2023 at 11:09 PM Dashamir Hoxha wrote: > I'd like to inform you that recently we (me, Mike and Holger) submitted a project proposal to Google Season of Docs: > https://salsa.debian.org/debian-edu/funding/gsod/-/blob/main/2023/project-proposal.md As a follow up, although this project was not sponsored by GSoD, I may still find some time to work on it during the summer. To get started, we should create these two repos on https://salsa.debian.org/debian-edu and give me full access on them: - docs - debian-edu.pages.debian.net (yes, it should be named like this) According to the salsa docs ( https://wiki.debian.org/Salsa/Doc#Web_page_hosting), the content of the first repo will be available on this url: https://debian-edu.pages.debian.net/docs/ , and the content of the second repo (which will be used for the new homepage) will be available on the url: https://debian-edu.pages.debian.net/ (as soon as I push some content to them). I do have some experience with static websites that are published on gitlab.com, and I believe that it should be almost the same on salsa. Kind regards, Dashamir
