Project Description
Our SUSE Support knowledge base sucks. It has a clunky UI, only has a What you see is what you (don't) get editor, doesn't show version history. I hate it, you hate it, and our customers hate using it and would rather pick up the phone and bother us.
This project's aim is to move away from Salesforce Knowledgebase to a FLOSS solution that allows:
- versioning and diffs
- defined formatting
- better text search
- tag and category organization (let's at least try to match wiki functionality)
- reverse link search and link validation (I don't know exactly what it's called, but the thing in wikimedia that allows us to see what links to what so we don't create orphan links)
- prettiness
What I'm envisioning is a repository of asciidoc markdown files in GitLab that are turned into XML Docbook articles, and we can apply the standard SUSE product documentation style sheet to create documents in a pdf and html format. You want a .pdf to send to the customer? No sweat. You want .html for the website? Easy.
How beautiful and consistent! How easy to use and learn!
Versioning and standard git best practice allow the review and quality control that's needed. Changes made by contributors would be tracked and approved by editors with privileges and responsibilities to publish by pulling into the master branch. From that, the KB article would be regenerated. Documentation as code.
DAPS written by Frank Sundermeyer et al. from Documentation is likely the best solution for this.
Goal for this Hackweek
I would like to have a prototype to show support management to convince them that it would be possible and desirable to migrate away from Salesforce knowledge base.
We'd build a tool chain that would flow asciidoc from a SUSE GitLab repo into XML Docbook and generate a downloadable pdf and an html file. Or even epub. You laugh, but having reference documentation on an ebook reader is a great help in the datacenter.
Since we don't want to lose all the work we've done, the real challenge is to come up with a migration tool chain as well. It seems as though it is possible to pull XML from Salesforce (whether DocBook valid remains to be seen) as well as some metadata.
We'd need to validate and tweak the result by hand in Support, but I hope we will do this once, and we'll be FREE from proprietary nonsense and join the GNU generation.
Resources
GitLab/GitHub repo soon.
I'm looking for buddies who have XML docbook pipeline experience, knowledge management experience, good ideas on how to make this idea into a better design that's easy to maintain, and are willing to lend a hand. :)
Particularly useful would be input and experience from the Product Documentation team, which operate the XML docbook templates on which we would like to piggyback.
Looking for hackers with the skills:
This project is part of:
No hackweek.
Activity
Comments
Similar Projects
Advent of Code: The Diaries by amanzini
Description
It was the Night Before Compile Time ...
Hackweek 25 (December 1-5) perfectly coincides with the first five days of Advent of Code 2025. This project will leverage this overlap to participate in the event in real-time.
To add a layer of challenge and exploration (in the true spirit of Hackweek), the puzzles will be solved using a non-mainstream, modern language like Ruby, D, Crystal, Gleam or Zig.
The primary project intent is not just simply to solve the puzzles, but to exercise result sharing and documentation. I'd create a public-facing repository documenting the process. This involves treating each day's puzzle as a mini-project: solving it, then documenting the solution with detailed write-ups, analysis of the language's performance and ergonomics, and visualizations.
|
\ ' /
-- (*) --
>*<
>0<@<
>>>@<<*
>@>*<0<<<
>*>>@<<<@<<
>@>>0<<<*<<@<
>*>>0<<@<<<@<<<
>@>>*<<@<>*<<0<*<
\*/ >0>>*<<@<>0><<*<@<<
___\\U//___ >*>>@><0<<*>>@><*<0<<
|\\ | | \\| >@>>0<*<0>>@<<0<<<*<@<<
| \\| | _(UU)_ >((*))_>0><*<0><@<<<0<*<
|\ \| || / //||.*.*.*.|>>@<<*<<@>><0<<<
|\\_|_|&&_// ||*.*.*.*|_\\db//_
""""|'.'.'.|~~|.*.*.*| ____|_
|'.'.'.| ^^^^^^|____|>>>>>>|
~~~~~~~~ '""""`------'
------------------------------------------------
This ASCII pic can be found at
https://asciiart.website/art/1831
Goals
Code, Docs, and Memes: An AoC Story
Have fun!
Involve more people, play together
Solve Days 1-5: Successfully solve both parts of the Advent of Code 2025 puzzles for Days 1-5 using the chosen non-mainstream language.
Daily Documentation & Language Review: Publish a detailed write-up for each day. This documentation will include the solution analysis, the chosen algorithm, and specific commentary on the language's ergonomics, performance, and standard library for the given task.
Testing and adding GNU/Linux distributions on Uyuni by juliogonzalezgil
Join the Gitter channel! https://gitter.im/uyuni-project/hackweek
Uyuni is a configuration and infrastructure management tool that saves you time and headaches when you have to manage and update tens, hundreds or even thousands of machines. It also manages configuration, can run audits, build image containers, monitor and much more!
Currently there are a few distributions that are completely untested on Uyuni or SUSE Manager (AFAIK) or just not tested since a long time, and could be interesting knowing how hard would be working with them and, if possible, fix whatever is broken.
For newcomers, the easiest distributions are those based on DEB or RPM packages. Distributions with other package formats are doable, but will require adapting the Python and Java code to be able to sync and analyze such packages (and if salt does not support those packages, it will need changes as well). So if you want a distribution with other packages, make sure you are comfortable handling such changes.
No developer experience? No worries! We had non-developers contributors in the past, and we are ready to help as long as you are willing to learn. If you don't want to code at all, you can also help us preparing the documentation after someone else has the initial code ready, or you could also help with testing :-)
The idea is testing Salt (including bootstrapping with bootstrap script) and Salt-ssh clients
To consider that a distribution has basic support, we should cover at least (points 3-6 are to be tested for both salt minions and salt ssh minions):
- Reposync (this will require using spacewalk-common-channels and adding channels to the .ini file)
- Onboarding (salt minion from UI, salt minion from bootstrap scritp, and salt-ssh minion) (this will probably require adding OS to the bootstrap repository creator)
- Package management (install, remove, update...)
- Patching
- Applying any basic salt state (including a formula)
- Salt remote commands
- Bonus point: Java part for product identification, and monitoring enablement
- Bonus point: sumaform enablement (https://github.com/uyuni-project/sumaform)
- Bonus point: Documentation (https://github.com/uyuni-project/uyuni-docs)
- Bonus point: testsuite enablement (https://github.com/uyuni-project/uyuni/tree/master/testsuite)
If something is breaking: we can try to fix it, but the main idea is research how supported it is right now. Beyond that it's up to each project member how much to hack :-)
- If you don't have knowledge about some of the steps: ask the team
- If you still don't know what to do: switch to another distribution and keep testing.
This card is for EVERYONE, not just developers. Seriously! We had people from other teams helping that were not developers, and added support for Debian and new SUSE Linux Enterprise and openSUSE Leap versions :-)
In progress/done for Hack Week 25
Guide
We started writin a Guide: Adding a new client GNU Linux distribution to Uyuni at https://github.com/uyuni-project/uyuni/wiki/Guide:-Adding-a-new-client-GNU-Linux-distribution-to-Uyuni, to make things easier for everyone, specially those not too familiar wht Uyuni or not technical.
openSUSE Leap 16.0
The distribution will all love!
https://en.opensuse.org/openSUSE:Roadmap#DRAFTScheduleforLeap16.0
Curent Status We started last year, it's complete now for Hack Week 25! :-D
[W]Reposync (this will require using spacewalk-common-channels and adding channels to the .ini file) NOTE: Done, client tools for SLMicro6 are using as those for SLE16.0/openSUSE Leap 16.0 are not available yet[W]Onboarding (salt minion from UI, salt minion from bootstrap scritp, and salt-ssh minion) (this will probably require adding OS to the bootstrap repository creator)[W]Package management (install, remove, update...). Works, even reboot requirement detection
Improve GNOME user documentation infrastructure and content by pkovar
Description
The GNOME user documentation infrastructure has been recently upgraded with a new site running at help.gnome.org. This is an ongoing project with a number of outstanding major issues to be resolved. When these issues are addressed, it will benefit both the upstream community and downstream projects and products consuming the GNOME user docs, including openSUSE.
Goals
Address primarily infrastructure-related issues filed for https://gitlab.gnome.org/Teams/Websites/help.gnome.org/, https://github.com/projectmallard and https://github.com/itstool/itstool projects. Work on contributor guides ported from https://wiki.gnome.org/DocumentationProject.html.
Resources
- https://gitlab.gnome.org/Teams/Websites/help.gnome.org/
- https://github.com/projectmallard/pintail
- https://github.com/projectmallard/projectmallard.org
- https://github.com/itstool/itstool