Skip to content

Commit a5115ea

Browse files
authored
conflict resolution for nginx guides (#1501)
* [UPDATE] Install Cpanel (#1399) * [UPDATE] Install Cpanel * Travis * Update requirements.txt (#1400) * Add script for identifying old non-deprecated guides (#1394) * Remove non-existent image reference * Rebuild theme * Update email-with-postfix-dovecot-and-mysql.md (#1405) Faulty DNS records * Find old guides (#1404) * Add script for identifying old non-deprecated guides * Add command line argument for number of results * Added Image (#1406) * [UPDATE] Use Authy in two-factor authentication instructions (#1401) * added authy to 2fa guide * Update linode-manager-security-controls.md * Add script for identifying old non-deprecated guides * Add og_description and minor copy edits * quick edit to line up numbers and a quick glance through at the md * Incorrect spelling on terraform description * Deprecate oracle xe (#1409) * Add script for identifying old non-deprecated guides * Deprecate Oracle XE Guide * [UPDATE] Manipulate Lists with sort and uniq (#1408) * Add script for identifying old non-deprecated guides * Update sort and uniq guide * Meltdown update jan17 (#1413) * added support faq to meltdown statement * meltdown statement modified date * meltdown trailing whitespace for travis * Rebuild theme * fixed anchor link to how to reboot (#1415) #how-to-reboot-into-an-updated-linode-kernel from #how-to-reboot-into-an-updated-kernel * serivce -> service (#1416) * Remove duplicated word in how-to-install-postgresql-on-ubuntu-16-04.md (#1417) Remove duplicated word in how-to-install-postgresql-on-ubuntu-16-04.md * Rebuild theme * Add first-timers-only badge (#1412) * Alpine Linux tech fixes (#1403) * grsecurity kernel now has the -hardened suffix instead of -grsec * wheel group is built-in without the need to create a new group it is also recommended by the default /etc/sudoers * Updated for newer inittab config. * Add Code of Conduct as exception to test_filename.py (#1423) Add Code of Conduct as exception to test_filename.py * Clear redirects with trailing slashes * Header changes and more indentation fixes (#1362) * Dockertalk image (#1425) * Add script for identifying old non-deprecated guides * Add banner image to Docker container connection guide * remove duplicates reported in #1418 (#1419) * Fix redundant wording (#1420) * Update UFW with h1 (#1315) Update UFW with h1 * typo: spelling error "impove" edited to "improve" (#1429) from: > We are constantly looking to __impove__ the quality of our library to: > We are constantly looking to __improve__ the quality of our library * Re-add deleted run command (#1432) * removed comma and lonely step 1 * colon to period * Minor edits from feedback * More minor fixes * Rebuild theme * [UPDATE] Mail server update (#1424) * wait * Done for now * Update Mail * ZFix Travis * [COPY] edits to mail server guide (#1436) * copy edits to mail server guide * deleted trailing whitespaces for travis * Formatting fixes for misc documents (#1435) * Remove mixed indentation for use public key authentication * Fixed indentation for accounts and passwords * Fixed escaped chars in fail2ban * Capitalized PNG to png * Guess who sam foo ssh mixed indent (#1441) * Remove mixed indentation for use public key authentication * Fixed indentation for accounts and passwords * Fixed escaped chars in fail2ban * Image and spacing fixes * Capitalized PNG to png * Add Authy clarification (#1442) * [NEW] code of conduct (#1422) * initial commit with code of conduct * no more trailing white spaces * no wiki and changed maint to contrib L69 * move Code of conduct up one (#1444) * initial commit with code of conduct * no more trailing white spaces * no wiki and changed maint to contrib L69 * moved code of conduct up to parent * [NEW] Rancher (#1396) * still working on this * rancher guide * Add script for identifying old non-deprecated guides * Tech edit * [COPY] edits to rancher guide (#1414) * copy edits to rancher guide * trailing whitespace fix for rancher * obligatory what is Rancher * rm leftover code of conduct in docs * Changed Meltdown fix to deployed (#1447) * [NEW] Chmod File Permissions (#1434) * [Update] Added octal notation section * Rephrased sentence * Revert "[NEW] Chmod File Permissions (#1434)" This reverts commit 23fd207. * [NEW] Chmod guide update (#1449) * [Update] Added octal notation section * Rephrased sentence * chmod copy edits (#1) * [NEW] Install R on Debian and Ubuntu and NEW] Deploy RStudio on Debian and Ubuntu (#1457) * [New] Install R on Ubuntu and Debian * Added RStudio Server reverse proxy guide * Tech edit * Finish tech edit * SOA = Start Of Authority (#1451) ref. https://tools.ietf.org/html/rfc1035 * Rebuild theme * Guaris jails update (#1458) * Update the SFTP guide * Update limiting-access-with-sftp-jails-on-debian-and-ubuntu.md * travis * Final check * [NEW] How to Install Go on Ubuntu (#1459) * Added new Guide on Installing Go * Travis-senpai pls no * Update install-go-on-ubuntu.md * Tech and copy edit * [NEW] Deploying microservices with docker (#1364) * Tech Edit and rewrite done * Tech check and copy edit * backup copy edit to microservices guide, Bob (#1369) * Removed deprecated shortcodes * [update]Fulll-virt disclaimer to block storage guide. (#1460) [update] Block storage update * Update install-alpine-linux-on-your-linode.md * Update how-to-use-block-storage-with-your-linode.md * [NEW] Thingsboard Guide (#1374) * Fix Roundcube alias and image * Draft of IoT guide * Initial draft. * Moved Java install to /java * Rebased; passed checks to nginx section * Update nginx to conf.d; finished rasp pi section * Copy Edit * Travis-kun, pls stop * Update install-java-jdk.md * Update install-thingsboard-iot-dashboard.md * [UPDATE] Create Physical Backups of a MySQL Database [UPDATE] Use mysqldump to Back Up MariaDB and MySQL Databases * Fix spelling errors from Vale initial fix (#1470) * Rebuild theme * Fix indentation for code blocks in sublists * [NEW] Elasticsearch plugins -Tylerjl (#1368) * WIP: elasticsearch plugins * some better style for the prelude section of the ES plugin guide * draft es plugin tutorial attachment section * draft phonetic analyzer section for es plugin guide * draft geoip section for es plugin guide * draft of user-agent section for es plugin guide * revise es plugin guide from initial draft * es plugin guide conclusion * Copy edit * Finish copy edit * [COPY] Elasticsearch plugins guides (#1410) * copy edit check on elasticsearch plugins * copy edits to elasticsearch shorts * Update index * Clear contribute.md topics list (#1475) Chose to leave this file in place so format is available when needed. * Initial block storage fixes (#1476) * GB -> GiB for block storage * Add test case for file extensions (#1471) * Add test case for file extensions Tests that all files have a lowercase extension. Written due to broken images with mismatched extension names. As written will ignore files without an extension. - Added .git and .gitignore to preexisting pytest fixtures - Fixed uppercase filenames (preexisting) - Added a new full_index fixture to cycle through all files * Change params in conftest * Remove incorrect guide * Replace 'Icinga2' with 'Icinga 2' (#1481) The official spelling of the project name is 'Icinga 2'. * FarmOS title rename (#1480) * Hot Fix * Update install-farmos.md * Title adjustments * Rebuild theme * Data center is two words (#1479) * Add January banner images (#1485) * [UPDATE] Install Caddy on CentOS * added wording to clarify latest licensing issues * Data center is two words (#1479) * Remove whitespace * Caddy compile Guide added * whitespace * [NEW] Split Files on Linux (#1461) * Draft of Split guide * Draft complete * Update install-alpine-linux-on-your-linode.md * Update how-to-use-block-storage-with-your-linode.md * [NEW] Thingsboard Guide (#1374) * Fix Roundcube alias and image * Draft of IoT guide * Initial draft. * Moved Java install to /java * Rebased; passed checks to nginx section * Update nginx to conf.d; finished rasp pi section * Copy Edit * Travis-kun, pls stop * Update install-java-jdk.md * Update install-thingsboard-iot-dashboard.md * [UPDATE] Create Physical Backups of a MySQL Database [UPDATE] Use mysqldump to Back Up MariaDB and MySQL Databases * Fix spelling errors from Vale initial fix (#1470) * Rebuild theme * Fix indentation for code blocks in sublists * [NEW] Elasticsearch plugins -Tylerjl (#1368) * WIP: elasticsearch plugins * some better style for the prelude section of the ES plugin guide * draft es plugin tutorial attachment section * draft phonetic analyzer section for es plugin guide * draft geoip section for es plugin guide * draft of user-agent section for es plugin guide * revise es plugin guide from initial draft * es plugin guide conclusion * Copy edit * Finish copy edit * [COPY] Elasticsearch plugins guides (#1410) * copy edit check on elasticsearch plugins * copy edits to elasticsearch shorts * Update index * Clear contribute.md topics list (#1475) Chose to leave this file in place so format is available when needed. * Initial block storage fixes (#1476) * GB -> GiB for block storage * Add test case for file extensions (#1471) * Add test case for file extensions Tests that all files have a lowercase extension. Written due to broken images with mismatched extension names. As written will ignore files without an extension. - Added .git and .gitignore to preexisting pytest fixtures - Fixed uppercase filenames (preexisting) - Added a new full_index fixture to cycle through all files * Change params in conftest * Remove incorrect guide * Add coreutils install for GNU split on MacOS * Replace 'Icinga2' with 'Icinga 2' (#1481) The official spelling of the project name is 'Icinga 2'. * FarmOS title rename (#1480) * Hot Fix * Update install-farmos.md * Title adjustments * Data center is two words (#1479) * Add January banner images (#1485) * [UPDATE] Install Caddy on CentOS * added wording to clarify latest licensing issues * Data center is two words (#1479) * Remove whitespace * Caddy compile Guide added * whitespace * Copy Edit * TRAVIS * Typo quick fix * [NEW] Tar and Gzip Quick Answer (#1478) * New quick answer and topical edits to tar docs * すみませんお願いします” ” * Tech edit * Clarified archive vs compress * [UPDATE] View the Beginning of Text Files with head (#1484) * Rebuild index/theme * Fix spelling mistakes and indentation ending in websites (#1487) * Fix spelling to security section from Vale (#1486) * Fix spelling to security section from Vale * Typo fix * Update title * Update how-to-use-yubikey-for-two-factor-ssh-authentication.md (#1488) Adds "key" to example in step 5. * [UPDATE] How to Grep for Text in Files | Update guide (#1483) * Grammar fixes from Vale (#1489) * Fixes to avoid incorrect dictionary generation (#1492) * Style fixes from Vale (#1490) * Additional Vale fixes (#1495) * Fix minor spelling and style errors * Add banner image and fix title (#1496) - add banner image - replace Thingsboard with ThingsBoard to match official documentation. * Rebuild theme * Add Vale to Travis CI (#1474) * Add Vale to Travis CI * Clean up dictionary Removed the following terms: - datacenter / datacenters (see #1479) - bottem (misspelling) - programatically (misspelling) - pyintotify (misspelling) - shortcod (misspelling) - spamhuas (misspelling) - shouldn (old tokenization) * Update dictionary Removed the following terms (#1474): * apha ("alpha" is in the standard dictionary, so I didn't add it here.) * datbase * deeplearning * ebjabberd * hilight * hilights * highlite * longivew * nonrecusive * standalones * tokyo2 * webbrowser * Update dictionary Removed the following terms (#1474): * apha ("alpha" is in the standard dictionary, so I didn't add it here.) * datbase * deeplearning * ebjabberd * hilight * hilights * highlite * longivew * nonrecusive * standalones * tokyo2 * webbrowser * Add "moby" and "backticks" * Add "ws", "Hilights", and "subfile(s)" * Parallelize TravisCI for pytest and Vale (#1497) * Remove NGINX reverse proxy guide * Fix broken anchor link in Static IP guide (#1499) * Update image alt tags and meta descriptions (#1498) * Update image alt tags * Update meta descriptions and comments from TVF * Rebuild theme * fixed link in deb 8 lemp * removed Gists from example
1 parent ab88f2d commit a5115ea

File tree

381 files changed

+6491
-1787
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

381 files changed

+6491
-1787
lines changed

.travis.yml

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,21 @@
11
language: python
2+
python:
3+
- "3.6"
4+
25
cache:
36
pip: true
4-
directories:
5-
- node_modules
6-
matrix:
7-
include:
8-
- python: "3.6"
9-
10-
before_install:
11-
- echo "Installing Hugo 0.31.1"
12-
# - curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
13-
# - sudo apt install nodejs
14-
- wget https://github.com/gohugoio/hugo/releases/download/v0.31/hugo_0.31_Linux-64bit.deb
15-
- sudo dpkg -i hugo*.deb
16-
- hugo version
17-
# - sudo npm install --global gulp-cli
18-
# - npm install
197

20-
install:
21-
- echo "Install pytest and pip"
22-
- pip install -r ci/requirements.txt
8+
env:
9+
- TEST_SUITE=vale
10+
- TEST_SUITE=pytest
2311

24-
before_script:
25-
- echo "Setting up local development server"
26-
- hugo server &
27-
- sleep 7
12+
before_install:
13+
- if [ $TEST_SUITE == pytest ]; then
14+
wget https://github.com/gohugoio/hugo/releases/download/v0.36/hugo_0.36_Linux-64bit.deb;
15+
sudo dpkg -i hugo*.deb;
16+
(hugo server &);
17+
fi
18+
- sleep 7
2819

2920
script:
30-
- echo "Checking for style guidelines"
31-
- python -m pytest -n 2
32-
21+
- ./ci/scripts/$TEST_SUITE.sh

.vale.ini

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
StylesPath = ci/vale/styles
2+
3+
# The minimum alert level to display (suggestion, warning, or error).
4+
#
5+
# CI builds will only fail on error-level alerts.
6+
MinAlertLevel = warning
7+
8+
# HTML tags to be ignored by Vale. `code` and `tt` are the default, but Linode
9+
# seems to use `strong` in a similar ways -- e.g., `**docker build -t ubuntu**`,
10+
# which could trigger two style issues ("docker" and "ubuntu") but is actually
11+
# a command.
12+
IgnoredScopes = code, strong, tt
13+
14+
# Specifies what Vale considers to be a boundary between words.
15+
WordTemplate = \s(?:%s)\s
16+
17+
[*.md]
18+
# A Linode-specific style (see ci/vale/styles/Linode) that implements spelling
19+
# and capitalization rules.
20+
#
21+
# To add another style, just add it to the `StylesPath` and update the setting
22+
# below (e.g., `BasedOnStyles = Linode, AnotherStyle`).
23+
BasedOnStyles = Linode
24+
25+
# Exclude `{{< file >}}`, `{{< file-excerpt >}}`, `{{< output >}}`,
26+
# and `{{< highlight ... >}}`.
27+
#
28+
# For a description (and unit tests) for these patterns see:
29+
# https://regex101.com/r/m9klBv/3/tests
30+
IgnorePatterns = (?s) *({{< output >}}.*?{{< ?/ ?output >}}), \
31+
(?s) *({{< ?file(?:-excerpt)? [^>]* ?>}}.*?{{< ?/ ?file(?:-excerpt)? ?>}}), \
32+
(?s) *({{< highlight \w+ >}}.*?{{< ?/ ?highlight >}})

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Linode Code of Conduct
2+
3+
## Our Pledge
4+
5+
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:
6+
7+
* age
8+
* body size
9+
* disability
10+
* ethnicity
11+
* gender identity and expression
12+
* level of experience
13+
* nationality
14+
* personal appearance
15+
* race
16+
* religion
17+
* sexual identity and orientation
18+
19+
## Our Standards
20+
21+
You can contribute to creating a positive environment in many ways. For example you can:
22+
23+
* use welcoming and inclusive language
24+
* be respectful of differing viewpoints and experiences
25+
* accept constructive criticism gracefully
26+
* focus on what is best for the community
27+
* show empathy towards other community members
28+
* be helpful and understanding
29+
30+
You should not:
31+
32+
* use sexualized language or imagery
33+
* make unwelcome sexual advances
34+
* troll, and make insulting or derogatory comments
35+
* make personal or political attacks
36+
* harass others, in public or private
37+
* publish others' private information, such as a physical or electronic address, without explicit permission
38+
* engage in any other conduct which could reasonably be considered bullying or inappropriate in a professional setting
39+
40+
## Our Responsibilities
41+
42+
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.
43+
44+
We have the right and responsibility to remove, edit, or reject:
45+
46+
* comments
47+
* commits
48+
* code
49+
* issues
50+
* other contributions that are not aligned to this code of conduct
51+
52+
We also reserve the right to temporarily or permanently ban any contributor for other behaviors we deem inappropriate, threatening, offensive, or harmful.
53+
54+
## Scope
55+
56+
This code of conduct applies whenever you are representing the project or community. For example you may be:
57+
58+
* working in a project space online or in the public
59+
* using an official project email address
60+
* posting via an official social media account
61+
* participating in an online or offline event
62+
63+
Project maintainers may further define and clarify representation of a project.
64+
65+
## Enforcement
66+
67+
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.
68+
69+
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.
70+
71+
## Attribution
72+
73+
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Linode logo](docs/assets/linode_readme_logo.png)
22

3-
# 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/)
3+
# 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/)
44

55
<img align="right" width="100" height="100" src="docs/assets/linode_readme_book.png">
66

@@ -20,7 +20,7 @@
2020

2121
## How can I write a guide?
2222

23-
We are constantly looking to impove the quality of our library. See our [rotating list of suggested topics](https://www.linode.com/docs/contribute/).
23+
We are constantly looking to improve the quality of our library. See our [rotating list of suggested topics](https://www.linode.com/docs/contribute/).
2424

2525
More detailed instructions on submitting a pull request can be found [here](CONTRIBUTING.md).
2626

ci/conftest.py

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,30 @@ def wrapper(md_filepath):
2121
return wrapper
2222

2323
@pytest.fixture(scope='module', autouse=True)
24-
def md_index(path='.', extension='*.md'):
24+
def file_index(path='.', extension=None):
2525
"""
2626
Traverses root directory
2727
"""
2828
index = []
29-
exclude_dir = ['node_modules', 'archetypes']
30-
exclude_file = ['_index.md']
29+
exclude_dir = ['node_modules', 'archetypes', '.git']
30+
exclude_file = ['_index.md','.gitignore']
3131
for root, dirnames, filenames in os.walk(path):
3232
dirnames[:] = [d for d in dirnames if d not in exclude_dir]
33-
for filename in fnmatch.filter(filenames, extension):
33+
if extension:
34+
filter_ext = fnmatch.filter(filenames, extension)
35+
else:
36+
filter_ext = filenames #Filter nothing
37+
for filename in filter_ext:
3438
if filename in exclude_file:
3539
continue
3640
index.append(os.path.join(root, filename))
3741
return index
3842

39-
40-
@pytest.fixture(params=md_index())
43+
@pytest.fixture(params=file_index(extension='*.md'))
4144
def md_filepath(request):
4245
return request.param
4346

47+
@pytest.fixture(params=file_index(extension=None))
48+
def all_filepaths(request):
49+
return request.param
50+

ci/scripts/pytest.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
3+
pip install -r ci/requirements.txt
4+
python -m pytest -n 2

ci/scripts/vale.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/bash
2+
3+
go get github.com/ValeLint/vale
4+
vale --glob='*.{md}' docs

ci/test_extensions.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import pytest
2+
import os
3+
4+
def test_extension(all_filepaths):
5+
"""
6+
Tests that all file extensions are lowercase.
7+
Ignores files without an extension.
8+
"""
9+
filename, file_extension = os.path.splitext(all_filepaths)
10+
assert file_extension == file_extension.lower(), 'File extensions must be lowercase.'

ci/test_filename.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Cartesian product of file names and extensions
55
# e.g. README.txt, README.md, CHANGELOG.txt, CHANGELOG.md ...
66
file_extensions = ['txt', 'md']
7-
names = ['README', 'CHANGELOG', 'CONTRIBUTING', 'LICENSE']
7+
names = ['README', 'CHANGELOG', 'CONTRIBUTING', 'LICENSE', 'CODE_OF_CONDUCT']
88
exempt_files = [('.'.join(x)) for x in itertools.product(names, file_extensions)]
99

1010
def test_filename(md_filepath):

0 commit comments

Comments
 (0)