From 424a21c7eb68b105327c3e4c3a090f961f248a7c Mon Sep 17 00:00:00 2001 From: Meindert-Jan Kroese Date: Mon, 18 May 2020 10:51:00 +0200 Subject: [PATCH] Let's encrypt connections --- CONTRIBUTING.md | 6 +++--- README.md | 10 +++++----- couscous.yml | 2 +- docs/configuration.md | 6 +++--- docs/faq.md | 2 +- docs/getting-started.md | 10 +++++----- docs/templates.md | 6 +++--- docs/travis.md | 2 +- src/Application/Cli/SelfUpdateCommand.php | 4 ++-- tests/UnitTest/Module/Core/Step/AddCnameTest.php | 2 +- .../Module/Markdown/Step/RenderMarkdownTest.php | 4 ++-- website/default.twig | 12 ++++++------ website/home-portfolio.twig | 10 +++++----- website/home.twig | 10 +++++----- 14 files changed, 43 insertions(+), 43 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d117b917..b18d451d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ First of all, **thank you** for contributing! Here are a few rules to follow in order to ease code reviews and merging: -- follow [PSR-1](http://www.php-fig.org/psr/1/) and [PSR-2](http://www.php-fig.org/psr/2/) +- follow [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-2](https://www.php-fig.org/psr/psr-2/) - run the test suite - write (or update) unit tests when applicable - write documentation for new features -- use [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- use [commit messages that make sense](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too. This is used to "clean" your pull request before merging it (we don't want commits such as `fix tests`, `fix 2`, `fix 3`, etc.). @@ -40,7 +40,7 @@ Then you can run `bin/couscous preview`. ## Building the phar -To generate the phar yourself, you need to allow Phar generation in your `php.ini` ([`phar.readonly = Off`](http://us1.php.net/manual/en/phar.configuration.php#ini.phar.readonly)). +To generate the phar yourself, you need to allow Phar generation in your `php.ini` ([`phar.readonly = Off`](https://www.php.net/manual/en/phar.configuration.php#ini.phar.readonly)). You also need to be able to use the `sha1sum` cli tool. diff --git a/README.md b/README.md index adf7ae9e..d0b5943f 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ layout: home --- -Couscous generates a [GitHub pages](http://pages.github.com/) website from your markdown documentation. +Couscous generates a [GitHub pages](https://pages.github.com/) website from your markdown documentation. [![Build Status](https://travis-ci.org/CouscousPHP/Couscous.svg?branch=master)](https://travis-ci.org/CouscousPHP/Couscous) -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/CouscousPHP/Couscous.svg)](http://isitmaintained.com/project/CouscousPHP/Couscous "Average time to resolve an issue") -[![Percentage of issues still open](http://isitmaintained.com/badge/open/CouscousPHP/Couscous.svg)](http://isitmaintained.com/project/CouscousPHP/Couscous "Percentage of issues still open") +[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/CouscousPHP/Couscous.svg)](https://isitmaintained.com/project/CouscousPHP/Couscous "Average time to resolve an issue") +[![Percentage of issues still open](https://isitmaintained.com/badge/open/CouscousPHP/Couscous.svg)](https://isitmaintained.com/project/CouscousPHP/Couscous "Percentage of issues still open") -**Everything is documented on [couscous.io](http://couscous.io/).** +**Everything is documented on [couscous.io](https://couscous.io/).** What follows is the documentation for contributors. @@ -58,7 +58,7 @@ class PutCouscousInBold implements \Couscous\Step } ``` -Couscous uses [PHP-DI](http://php-di.org/) for wiring everything together with dependency injection. +Couscous uses [PHP-DI](https://php-di.org/) for wiring everything together with dependency injection. The full list of steps is configured in [`src/Application/config.php`](src/Application/config.php). diff --git a/couscous.yml b/couscous.yml index f60a80a0..33fefcc3 100644 --- a/couscous.yml +++ b/couscous.yml @@ -10,7 +10,7 @@ scripts: before: - lessc --clean-css website/less/main.less website/css/all.min.css -baseUrl: http://couscous.io +baseUrl: https://couscous.io cname: couscous.io menu: diff --git a/docs/configuration.md b/docs/configuration.md index fd2a5321..e918e762 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -52,7 +52,7 @@ title: Hello! # Base URL of the published website (no "/" at the end!) # You are advised to set and use this variable to write your links in the HTML layouts -baseUrl: http://username.github.io/your-project +baseUrl: https://username.github.io/your-project ``` **Note:** any variable you put in `couscous.yml` is called **Metadata**. You can use these variables in templates for example. Learn more about this in the [Metadata documentation](metadata.md). @@ -65,13 +65,13 @@ To use a CNAME for your Couscous-generated documentation so that your docs point Metadata can also be specified from the command line: ```bash -$ couscous generate --config baseUrl=http://prod.server.com --config "fooBar=Baz Qux" +$ couscous generate --config baseUrl=https://prod.server.com --config "fooBar=Baz Qux" ``` This command will work exactly as if the following text was included in `couscous.yml`: ```yaml -baseUrl: http://prod.server.com +baseUrl: https://prod.server.com fooBar: Baz Qux ``` diff --git a/docs/faq.md b/docs/faq.md index 8e58609d..bfcd8dc9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -20,7 +20,7 @@ Links in Markdown are rewritten to link to HTML pages: #### Can I use it for a blog? -Probably not yet, but you are welcome to try. [PHP-DI's website](http://php-di.org/news/) has a pseudo-blog where the article list is written manually: it's possible, but not (yet) super easy. +Probably not yet, but you are welcome to try. [PHP-DI's website](https://php-di.org/news/) has a pseudo-blog where the article list is written manually: it's possible, but not (yet) super easy. #### Can I deploy the website to something else than GitHub Pages? diff --git a/docs/getting-started.md b/docs/getting-started.md index ee0044ed..22f69ee1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -11,7 +11,7 @@ Couscous requires PHP 5.4 or above on your machine. ### Composer -If you have already [set up a global install of Composer](http://akrabat.com/php/global-installation-of-php-tools-with-composer/) just run: +If you have already [set up a global install of Composer](https://akrabat.com/php/global-installation-of-php-tools-with-composer/) just run: ``` $ composer global require couscous/couscous @@ -24,10 +24,10 @@ If you rather have it self-contained, use the **Phar** method just below. ### Phar -Alternatively, you can download [couscous.phar](http://couscous.io/couscous.phar): +Alternatively, you can download [couscous.phar](https://couscous.io/couscous.phar): ```bash -$ curl -OSL http://couscous.io/couscous.phar +$ curl -OSL https://couscous.io/couscous.phar ``` **Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.** @@ -73,7 +73,7 @@ $ couscous deploy Couscous will generate the website (in a temp directory) and publish it in the `gh-pages` branch of your git repository. This will remove everything that exists in the `gh-pages` branch, commit in your name, and **push** to GitHub. -The website is now online: [http://your-username.github.io/your-project/](http://your-username.github.io/your-project/). +The website is now online: [https://your-username.github.io/your-project/](https://your-username.github.io/your-project/). The `deploy` command will not change anything in your current branch (e.g. master branch). It will only affect the `gh-pages` branch. @@ -87,7 +87,7 @@ $ couscous deploy --branch master ## Customizing the template -Couscous provides [a default template](https://github.com/CouscousPHP/Template-Light) (and a [few others to choose from](http://couscous.io/templates.html)), but you can of course come up with your own. Writing templates is really simple, and it is all explained in the [templates documentation](templates.md). +Couscous provides [a default template](https://github.com/CouscousPHP/Template-Light) (and a [few others to choose from](https://couscous.io/templates.html)), but you can of course come up with your own. Writing templates is really simple, and it is all explained in the [templates documentation](templates.md). ## Updating Couscous diff --git a/docs/templates.md b/docs/templates.md index 084e9ea8..9647bcac 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -11,7 +11,7 @@ It allows many projects to reuse the same template. To write a remote template, just write a normal template inside a directory (read below for understanding how). Then publish that directory online (for example on GitHub). -You can find some examples of templates [here](http://couscous.io/templates.html). +You can find some examples of templates [here](https://couscous.io/templates.html). The [Basic](https://github.com/CouscousPHP/Template-Basic) template is a good way to start. *ProTip:* To preview your template, you can use `couscous preview` (Couscous will use your template's Readme). In order to tell Couscous that the template is in the root of the repository (and not in a `website/` subdirectory), use the following configuration: @@ -64,7 +64,7 @@ that overrides `default.twig`: {% endblock %} ``` -You can set your `README.md` (i.e. your home page) to use that layout using [YAML front matter](http://jekyllrb.com/docs/frontmatter/) in the Markdown file: +You can set your `README.md` (i.e. your home page) to use that layout using [YAML front matter](https://jekyllrb.com/docs/frontmatter/) in the Markdown file: ```markdown --- @@ -153,4 +153,4 @@ A good rule of thumb is: **if it works on GitHub.com, it will work with Couscous If a `bower.json` file is present in the `website/` directory, dependencies will be installed automatically. -In that case, you need [to have Bower installed](http://bower.io/). If you don't have a `bower.json`, you don't need to install Bower. +In that case, you need [to have Bower installed](https://bower.io/). If you don't have a `bower.json`, you don't need to install Bower. diff --git a/docs/travis.md b/docs/travis.md index b6f0f6c4..28688496 100644 --- a/docs/travis.md +++ b/docs/travis.md @@ -13,7 +13,7 @@ In order to push to your repository from Travis, you need to authorize Travis. Y - from your GitHub account, go in [*Settings > Personal access tokens*](https://github.com/settings/tokens) - create a new **Personal Access Token** and give it the `public_repo` permission (if the repository is public) -- install the [Travis command line tool](http://blog.travis-ci.com/2013-01-14-new-client/) +- install the [Travis command line tool](https://blog.travis-ci.com/2013-01-14-new-client/) `gem install travis` diff --git a/src/Application/Cli/SelfUpdateCommand.php b/src/Application/Cli/SelfUpdateCommand.php index 9cf988bd..44b8019e 100644 --- a/src/Application/Cli/SelfUpdateCommand.php +++ b/src/Application/Cli/SelfUpdateCommand.php @@ -31,8 +31,8 @@ protected function configure() protected function execute(InputInterface $input, OutputInterface $output) { $updater = new Updater(null, false); - $updater->getStrategy()->setPharUrl('http://couscous.io/couscous.phar'); - $updater->getStrategy()->setVersionUrl('http://couscous.io/couscous.version'); + $updater->getStrategy()->setPharUrl('https://couscous.io/couscous.phar'); + $updater->getStrategy()->setVersionUrl('https://couscous.io/couscous.version'); $result = $updater->update(); $result ? $output->writeln('Phar file updated successfully!') : $output->writeln('No need to update.'); diff --git a/tests/UnitTest/Module/Core/Step/AddCnameTest.php b/tests/UnitTest/Module/Core/Step/AddCnameTest.php index 71266c39..73a082a0 100644 --- a/tests/UnitTest/Module/Core/Step/AddCnameTest.php +++ b/tests/UnitTest/Module/Core/Step/AddCnameTest.php @@ -20,7 +20,7 @@ public function it_should_add_the_cname_file() $project = new Project('foo', 'bar'); $project->metadata = new Metadata(); - $project->metadata['cname'] = 'http://www.couscous.io'; + $project->metadata['cname'] = 'https://www.couscous.io'; $step = new AddCname(); $step->__invoke($project); diff --git a/tests/UnitTest/Module/Markdown/Step/RenderMarkdownTest.php b/tests/UnitTest/Module/Markdown/Step/RenderMarkdownTest.php index f695e909..c116b575 100644 --- a/tests/UnitTest/Module/Markdown/Step/RenderMarkdownTest.php +++ b/tests/UnitTest/Module/Markdown/Step/RenderMarkdownTest.php @@ -28,7 +28,7 @@ public function testClassicMarkdown() ##### Title 5 ###### Title 6 -Hello *world*! This is a [link](http://github.com). +Hello *world*! This is a [link](https://github.com). this is a code block @@ -49,7 +49,7 @@ public function testClassicMarkdown()

Title 4

Title 5
Title 6
-

Hello world! This is a link.

+

Hello world! This is a link.

this is a
 code block
diff --git a/website/default.twig b/website/default.twig index 63f9e1a8..15e9d42d 100644 --- a/website/default.twig +++ b/website/default.twig @@ -15,11 +15,11 @@ - - - - - + + + + + @@ -125,7 +125,7 @@ g.defer=true; g.async=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s); })(); - + {% endblock %} diff --git a/website/home-portfolio.twig b/website/home-portfolio.twig index b16cc442..4875f169 100644 --- a/website/home-portfolio.twig +++ b/website/home-portfolio.twig @@ -27,7 +27,7 @@
- +
@@ -43,7 +43,7 @@
- +
@@ -62,7 +62,7 @@
- +
@@ -94,7 +94,7 @@
- +
@@ -126,7 +126,7 @@
- +
diff --git a/website/home.twig b/website/home.twig index 51be405c..8790c055 100644 --- a/website/home.twig +++ b/website/home.twig @@ -120,7 +120,7 @@

Couscous is different from other static websites generators like Sculpin - or Jekyll. + or Jekyll. These are generic static websites generator, sometimes meant for blogs, and using them to put documentation online is clunky. They also all require a specific directory layout which is @@ -152,7 +152,7 @@

Simply run:

- 
curl -OS http://couscous.io/couscous.phar
+                    
curl -OS https://couscous.io/couscous.phar
 php couscous.phar preview

                     
Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.

                     

@@ -177,13 +177,13 @@ php couscous.phar preview

- Markdown Extra support + Markdown Extra support

Fenced code blocks

- Bower support + Bower support

Responsive default templates @@ -191,7 +191,7 @@ php couscous.phar preview

- Twig templates + Twig templates

YAML configuration