conflict resolution for nginx guides

.travis.yml

@@ -1,32 +1,21 @@
 language: python
+python:
+  - "3.6"
+
 cache:
     pip: true
-    directories:
-    - node_modules
-matrix:
-    include:
-    - python: "3.6"
-
-before_install:
-    - echo "Installing Hugo 0.31.1"
-#    - curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
-#    - sudo apt install nodejs
-    - wget https://github.com/gohugoio/hugo/releases/download/v0.31/hugo_0.31_Linux-64bit.deb
-    - sudo dpkg -i hugo*.deb
-    - hugo version
-#    - sudo npm install --global gulp-cli
-#    - npm install
 
-install:
-    - echo "Install pytest and pip"
-    - pip install -r ci/requirements.txt
+env:
+  - TEST_SUITE=vale
+  - TEST_SUITE=pytest
 
-before_script:
-    - echo "Setting up local development server"
-    - hugo server &
-    - sleep 7
+before_install:
+  - if [ $TEST_SUITE == pytest ]; then
+      wget https://github.com/gohugoio/hugo/releases/download/v0.36/hugo_0.36_Linux-64bit.deb;
+      sudo dpkg -i hugo*.deb;
+      (hugo server &);
+    fi
+  - sleep 7
 
 script:
-    - echo "Checking for style guidelines"
-    - python -m pytest -n 2
-
+  - ./ci/scripts/$TEST_SUITE.sh

.vale.ini

@@ -0,0 +1,32 @@
+StylesPath = ci/vale/styles
+
+# The minimum alert level to display (suggestion, warning, or error).
+#
+# CI builds will only fail on error-level alerts.
+MinAlertLevel = warning
+
+# HTML tags to be ignored by Vale. `code` and `tt` are the default, but Linode
+# seems to use `strong` in a similar ways -- e.g., `**docker build -t ubuntu**`,
+# which could trigger two style issues ("docker" and "ubuntu") but is actually
+# a command.
+IgnoredScopes = code, strong, tt
+
+# Specifies what Vale considers to be a boundary between words.
+WordTemplate = \s(?:%s)\s
+
+[*.md]
+# A Linode-specific style (see ci/vale/styles/Linode) that implements spelling
+# and capitalization rules.
+#
+# To add another style, just add it to the `StylesPath` and update the setting
+# below (e.g., `BasedOnStyles = Linode, AnotherStyle`).
+BasedOnStyles = Linode
+
+# Exclude `{{< file >}}`, `{{< file-excerpt >}}`, `{{< output >}}`,
+# and `{{< highlight ... >}}`.
+#
+# For a description (and unit tests) for these patterns see:
+# https://regex101.com/r/m9klBv/3/tests
+IgnorePatterns = (?s) *({{< output >}}.*?{{< ?/ ?output >}}), \
+(?s) *({{< ?file(?:-excerpt)? [^>]* ?>}}.*?{{< ?/ ?file(?:-excerpt)? ?>}}), \
+(?s) *({{< highlight \w+ >}}.*?{{< ?/ ?highlight >}})

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Linode Code of Conduct
+
+## Our Pledge
+
+In order to encourage an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of:
+
+* age
+* body size
+* disability
+* ethnicity
+* gender identity and expression
+* level of experience
+* nationality
+* personal appearance
+* race
+* religion
+* sexual identity and orientation
+
+## Our Standards
+
+You can contribute to creating a positive environment in many ways. For example you can:
+
+* use welcoming and inclusive language
+* be respectful of differing viewpoints and experiences
+* accept constructive criticism gracefully
+* focus on what is best for the community
+* show empathy towards other community members
+* be helpful and understanding
+
+You should not:
+
+* use sexualized language or imagery
+* make unwelcome sexual advances
+* troll, and make insulting or derogatory comments
+* make personal or political attacks
+* harass others, in public or private
+* publish others' private information, such as a physical or electronic address, without explicit permission
+* engage in any other conduct which could reasonably be considered bullying or inappropriate in a professional setting
+
+## Our Responsibilities
+
+As project maintainers, we are responsible for clarifying the standards of acceptable behavior and we are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour.
+
+We have the right and responsibility to remove, edit, or reject:
+
+* comments
+* commits
+* code
+* issues
+* other contributions that are not aligned to this code of conduct
+
+We also reserve the right to temporarily or permanently ban any contributor for other behaviors we deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This code of conduct applies whenever you are representing the project or community. For example you may be:
+
+* working in a project space online or in the public
+* using an official project email address
+* posting via an official social media account
+* participating in an online or offline event
+
+Project maintainers may further define and clarify representation of a project.
+
+## Enforcement
+
+You should report any instances of abusive, harassing, or otherwise unacceptable behaviour to the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain the anonymity of the reporter of an incident. We may post further details of specific enforcement policies separately.
+
+Project contributors who do not follow or enforce this code of conduct in good faith may face temporary or permanent consequences. These will be determined by members of the project's leadership.
+
+## Attribution
+
+This code of conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, and the [gov.uk open standards CODE_OF_CONDUCT.md](https://github.com/alphagov/open-standards/blob/master/CODE_OF_CONDUCT.md).

README.md

@@ -1,6 +1,6 @@
 ![Linode logo](docs/assets/linode_readme_logo.png)
 
-# Guides and Tutorials [![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-blue.svg)](https://creativecommons.org/licenses/by/4.0/)
+# Guides and Tutorials [![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-blue.svg)](https://creativecommons.org/licenses/by/4.0/) [![first-timers-only](http://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)
 
 <img align="right" width="100" height="100" src="docs/assets/linode_readme_book.png">
 
@@ -20,7 +20,7 @@
 
 ## How can I write a guide?
 
-We are constantly looking to impove the quality of our library. See our [rotating list of suggested topics](https://www.linode.com/docs/contribute/).
+We are constantly looking to improve the quality of our library. See our [rotating list of suggested topics](https://www.linode.com/docs/contribute/).
 
 More detailed instructions on submitting a pull request can be found [here](CONTRIBUTING.md).
 

ci/conftest.py

@@ -21,23 +21,30 @@ def wrapper(md_filepath):
     return wrapper
 
 @pytest.fixture(scope='module', autouse=True)
-def md_index(path='.', extension='*.md'):
+def file_index(path='.', extension=None):
     """
     Traverses root directory
     """
     index = []
-    exclude_dir = ['node_modules', 'archetypes']
-    exclude_file = ['_index.md']
+    exclude_dir = ['node_modules', 'archetypes', '.git']
+    exclude_file = ['_index.md','.gitignore']
     for root, dirnames, filenames in os.walk(path):
         dirnames[:] = [d for d in dirnames if d not in exclude_dir]
-        for filename in fnmatch.filter(filenames, extension):
+        if extension:
+            filter_ext = fnmatch.filter(filenames, extension)
+        else:
+            filter_ext = filenames #Filter nothing
+        for filename in filter_ext:
             if filename in exclude_file:
                 continue
             index.append(os.path.join(root, filename))
     return index
 
-
-@pytest.fixture(params=md_index())
+@pytest.fixture(params=file_index(extension='*.md'))
 def md_filepath(request):
     return request.param
 
+@pytest.fixture(params=file_index(extension=None))
+def all_filepaths(request):
+    return request.param
+

ci/scripts/pytest.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+pip install -r ci/requirements.txt
+python -m pytest -n 2

ci/scripts/vale.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+go get github.com/ValeLint/vale
+vale --glob='*.{md}' docs

ci/test_extensions.py

@@ -0,0 +1,10 @@
+import pytest
+import os
+
+def test_extension(all_filepaths):
+    """
+    Tests that all file extensions are lowercase.
+    Ignores files without an extension.
+    """
+    filename, file_extension = os.path.splitext(all_filepaths)
+    assert file_extension == file_extension.lower(), 'File extensions must be lowercase.'

ci/test_filename.py

@@ -4,7 +4,7 @@
 # Cartesian product of file names and extensions
 # e.g. README.txt, README.md, CHANGELOG.txt, CHANGELOG.md ...
 file_extensions = ['txt', 'md']
-names = ['README', 'CHANGELOG', 'CONTRIBUTING', 'LICENSE']
+names = ['README', 'CHANGELOG', 'CONTRIBUTING', 'LICENSE', 'CODE_OF_CONDUCT']
 exempt_files = [('.'.join(x)) for x in itertools.product(names, file_extensions)]
 
 def test_filename(md_filepath):