Skip to content

Instantly share code, notes, and snippets.

Avatar

Gonzalo Bulnes Guilpain gonzalo-bulnes

View GitHub Profile
@gonzalo-bulnes
gonzalo-bulnes / references_for_installation_docs.md
Last active Jun 26, 2021
A few references that may be useful when writing docs that involve installing or setting up software.
View references_for_installation_docs.md

References

Netgate setup / configuration docs

Example page for reference

  1. I find the "< Previous (Safety and Legal) | (Reinstalling pfSense ...) Next >" navigation is an effective way to provide a sense of scope to the page and communicate early on if more steps are to be expected or not. It is repeated at the bottom of the page content, which I find an easy way to be reminded that the next step may (or not) be relevant, and to get to it if deemed relevant.
  2. Providing instructions for multiple platforms: the page uses tabs to provide short alternatives by platform, and references a section of Client-specific examples for detailed instructions.
  • [Sphinx Tabs][tabs] extension docs. Bonus: the tabs can be grouped for a tailored reading experience! I love that.
@gonzalo-bulnes
gonzalo-bulnes / updating-links.md
Last active Jan 9, 2021
Update links in the SecureDrop documentation using the output of linkcheck.
View updating-links.md
@gonzalo-bulnes
gonzalo-bulnes / simian-notes.md
Last active Jun 12, 2017
A few notes taken while reading the github.com/mandykoh/simian code.
View simian-notes.md
@gonzalo-bulnes
gonzalo-bulnes / convert.sh
Last active Mar 10, 2017
Convert a CSV file with Windows (or broken) encoding to Unix encoding (including end of line characters).
View convert.sh
# Convert input with Windows (or broken) encoding to Unix encoding (including end of line characters).
#
# Usage:
#
# cat windows.csv | ./convert.sh > unix.csv
# Convert encoding to UTF-8
iconv -f iso-8859-1 -t utf-8 < /dev/stdin | \
# Remove the broken line endings (or the unnecessary carriage returns)
View .bash_completion
# Provide autocompletion for a Makefile targets.
#
# Usage:
# source .bash_completion # this file
# make[tab] # autocompletes the .PHONY targets :)
#
# See https://debian-administration.org/article/317/An_introduction_to_bash_completion_part_2
_make()
{
local cur prev opts
@gonzalo-bulnes
gonzalo-bulnes / README.md
Last active Oct 26, 2015
Example of modularization with Python packages.
View README.md
# Run the hello game:
python hello_game.py

# Run the hello and bye game:
python hello_and_bye_game.py
@gonzalo-bulnes
gonzalo-bulnes / docker-compose.yml
Last active Oct 1, 2015
Setup a development environment for Bottled Water using Docker Compose.
View docker-compose.yml
zookeeper:
image: confluent/zookeeper
ports:
- 2181
kafka:
image: confluent/kafka
ports:
- "9092:9092"
links:
@gonzalo-bulnes
gonzalo-bulnes / solarized.bash
Last active Aug 7, 2018 — forked from kraft001/solarized.bash
Solarized Gnome Terminal + Tmux + Vim (using the Tmux Plugin Manager and Vim Pathogen)
View solarized.bash
# Store all solarized files in one place - :)
mkdir ~/.solarized
cd ~/.solarized
# http://www.webupd8.org/2011/04/solarized-must-have-color-paletter-for.html
git clone https://github.com/seebi/dircolors-solarized.git
eval `dircolors ~/.solarized/dircolors-solarized/dircolors.256dark`
ln -s ~/.solarized/dircolors-solarized/dircolors.256dark ~/.dir_colors
git clone https://github.com/sigurdga/gnome-terminal-colors-solarized.git
@gonzalo-bulnes
gonzalo-bulnes / Rakefile
Created Jun 2, 2015
Add documentation improvement suggestions to a Ruby test suite (by defining a Rake task with Inch).
View Rakefile
# Rakefile
begin
require 'inch/rake'
Inch::Rake::Suggest.new(:inch) do |suggest|
suggest.args << "--private"
suggest.args << "--pedantic"
end
rescue LoadError
@gonzalo-bulnes
gonzalo-bulnes / Rakefile
Created Apr 5, 2015
Add validation of an app.json file to a Ruby test suite (by defining a Rake task).
View Rakefile
# Rakefile
namespace :app_json do
desc 'Validate the app.json manifest'
task :validate do
require 'rainbow'
# check if the app.json validator is available
`which app.json`
if $?.exitstatus != 0