Daily Shaarli
February 11, 2023
This section provides a quick glimpse into the expressive power of YAML. It is not expected that the first-time reader grok all of the examples. Rather, these selections are used as motivation for the remainder of the specification.
When NeoMutt starts up it looks for two configuration files – one “ system” file and one “ user” file.
NeoMutt first reads the system configuration file, then the user configuration file. The two files are merged in the sense that "last setting wins". That is, if a setting is defined in both files, the user configuration file's value for that setting is the one that takes precedence and becomes effective.
NeoMutt searches for several different file names when looking for config. It looks for NeoMutt config files before Mutt config files and versioned config before plain config.
In this tutorial, you’ll learn how to quickly build documentation for a Python package using MkDocs and mkdocstrings. These tools allow you to generate nice-looking and modern documentation from Markdown files and your code’s docstrings.
Maintaining auto-generated documentation means less effort because you’re linking information between your code and the documentation pages. However, good documentation is more than just the technical description pulled from your code! Your project will appeal more to users if you guide them through examples and connect the dots between the docstrings.
The Material for MkDocs theme makes your documentation look good without any extra effort and is used by popular projects such as Typer CLI and FastAPI.
Columnar time-series database with high performance ingestion and SQL analytics you know and love from QuestDB open source, now on the cloud.
The general consensus is that is too hard or too expensive to run a small business on entirely free software. After running my company for 5 years on entirely free software I think this is not the case. We have instant communication, shared calendars, groupware, single sign on, and a single administration interface! Things have worked out really well and in many ways are better integrated than trying to combine multiple different cloud based services.
In this talk I will walk through how our infrastructure works, what the pitfalls were, and what the benefits are. At the end I'll give a short demo on a couple of virtual machines to show off the user and admin experience.
The pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.
pytest requires: Python 3.7+ or PyPy3.
YAML (/ˈjæməl/) (see § History and name) is a human-readable data-serialization language. It is commonly used for configuration files and in applications where data is being stored or transmitted. YAML targets many of the same communications applications as Extensible Markup Language (XML) but has a minimal syntax which intentionally differs from Standard Generalized Markup Language (SGML).[1] It uses both Python-style indentation to indicate nesting, and a more compact format that uses [...] for lists and {...} for maps[1] thus JSON files are valid YAML 1.2.[2]
Change Messy Software Without Breaking It
The Diátaxis framework aims to solve the problem of structure in technical documentation. It adopts a systematic approach to understanding the needs of documentation users in their cycle of interaction with a product.
The name Diátaxis comes from the Ancient Greek δῐᾰ́τᾰξῐς: dia (“across”) and taxis (“arrangement”).
Diátaxis identifies four modes of documentation - tutorials, how-to guides, technical reference and explanation. It derives its structure from the relationship between them.
In Diátaxis, each of these modes (or types) answers to a different user need, fulfils a different purpose and requires a different approach to its creation.
If you nowadays work with and on the cloud or simply *-as-Code, chances are you came into proximity of ‘Yet Another Markup Language’ (YAML). Deceptively simple in appearance, YAML provides you with a plethora of ways to shoot yourself in the foot. This talk discusses a number of common pitfalls. In a nutshell: Why YAML is not as easy as you may think.
Open-Source kanban. WeKan ® is registered trademark in Finland. Other countries usually honor trademarks of one country.
%YAML 1.2
YAML: YAML Ain't Markup Language™
YAML Resources:
YAML Specifications:
- YAML 1.2:
- Revision 1.2.2 # Oct 1, 2021 New
- Revision 1.2.1 # Oct 1, 2009
- Revision 1.2.0 # Jul 21, 2009
- YAML 1.1
- YAML 1.0
When I say "Legacy Code" I mean valuable code you're afraid to change.
We all have to deal with Legacy Code. But it's damn hard to!
Here you'll find answers to your questions. I'm sharing useful tips and concrete advice that will help you tame the legacy codebase you've inherited.
There are several different docstring formats which one can use in order to enable Sphinx’s autodoc extension to automatically generate documentation. For this tutorial we will use the Sphinx format, since, as the name suggests, it is the standard format used with Sphinx. Other formats include Google (see here) and NumPy (see here), but they require the use of Sphinx’s napoleon extension, which is beyond the scope of this tutorial.
Do you document your code? Imagine that you need to get back to your code in 6 month after you wrote it, there is always a big possibility that you will have to spend some time to find out how this code works. Or if someone else wrote some code, which is already in production and your task is to fix a bug in it and there is no documentation and no one actually knows what this code does.
There are more benefits of implementing continuous documentation for the code:
easy to onboard new team members,
easy to share knowledge,
if this code is open source - easy to start contributing,
easy to see purpose and motivation of each piece of code,
easy to keep versioning for each new release of the code.It this talk I will show the difference between documentation types and will show a demo in the end of the talk.