Initial commit

README.rst

@@ -0,0 +1,40 @@
+Linux Mint Troubleshooting Guide
+================================
+
+This document can be read at https://linuxmint-troubleshooting-guide.readthedocs.io.
+
+The docs are written in `reStructuredText <http://www.sphinx-doc.org/rest.html>`_.
+
+Build:
+------
+
+.. image:: https://readthedocs.org/projects/linuxmint-troubleshooting-guide/badge/?version=latest
+    :target: https://linuxmint-troubleshooting-guide.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+
+To build locally install ``python-sphinx`` and run ``make html`` in the ``docs`` directory.
+
+Resources:
+----------
+
+* https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
+* http://www.sphinx-doc.org/en/stable/markup/inline.html
+* http://www.writethedocs.org/guide/
+* https://developers.google.com/style/highlights
+
+License:
+--------
+
+.. image:: https://img.shields.io/badge/code-GPLv3-blue.svg
+    :target: https://www.gnu.org/licenses/gpl-3.0.en.html
+    :alt: Code GPLv3
+
+.. image:: https://img.shields.io/badge/documentation-CC%20BY--ND-lightgrey.svg
+    :target: https://creativecommons.org/licenses/by-nd/4.0/
+    :alt: Documentation CC BY-ND
+
+.. image:: https://img.shields.io/badge/screenshots-CC0-ff69b4.svg
+    :target: https://creativecommons.org/publicdomain/zero/1.0/
+    :alt: Screenshots CC0
+

docs/.gitignore

@@ -0,0 +1 @@
+_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Linux Mint Troubleshooting Guide
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Linux Mint Troubleshooting Guide'
+copyright = '2017, Linux Mint'
+author = 'Linux Mint'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+locale_dirs = ['../po']
+gettext_compact = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+#
+html_favicon = 'favicon.ico'
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TroubleshootingGuidedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'TroubleshootingGuide.tex', 'Troubleshooting Guide',
+     'Linux Mint', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'troubleshootingguide', 'Troubleshooting Guide',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'TroubleshootingGuide', 'Troubleshooting Guide',
+     author, 'troubleshootingguide', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/index.rst

@@ -0,0 +1,36 @@
+Linux Mint Troubleshooting Guide
+================================
+
+.. figure:: images/qr.png
+      :width: 100px
+      :align: right
+
+This guide will help you troubleshoot issues on your computers, find help within the commnunity and report bugs to the development team.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: General concepts
+
+   Observation
+   Reproducibility
+   Research and Help
+   Cause Analysis
+   Solutions and workarounds
+   Reports
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Reporting bugs
+
+   Goal (to fix bugs, not to document everything that is or might be wrong)
+   Invalid bug reports (what not to report)
+   what info to include (enough for devs to reproduce or understand)
+   where (which project, upstream)
+   the lifecycle of a bug report
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Frequently Asked Questions
+
+   Ideas and feature requests
+

docs/observation.rst

@@ -0,0 +1,3 @@
+Observation
+===========
+

docs/sections.rst

@@ -0,0 +1,10 @@
+.. comments:
+    For some reason, with sphinx 1.3.6, toctree caption fields aren't picked up sphinx-build make-gettext.
+    We're putting the section names here to force them into the POT file.
+
+General concepts
+
+Finding help
+
+Reporting bugs
+

import-lp-translations

@@ -0,0 +1,17 @@
+#!/usr/bin/python3
+import os
+
+os.system("mkdir -p po")
+os.system("rm -rf po/*")
+
+pages = []
+for page in os.listdir("docs"):
+    if page.endswith(".rst"):
+        pages.append(page.replace(".rst", ""))
+
+for po in sorted(os.listdir("launchpad-translations")):
+    if po.endswith(".po"):
+        locale = po.split("-")[-1].replace(".po", "")
+        os.system("mkdir -p po/%s/LC_MESSAGES" % locale)
+        for page in sorted(pages):
+            os.system("cp launchpad-translations/%s po/%s/LC_MESSAGES/%s.po" % (po, locale, page))