Skip to content

Commit fbaab4d

Browse files
committed
Update http to https
1 parent b99cfbe commit fbaab4d

18 files changed

Lines changed: 48 additions & 48 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can directly submit a pull request using the fork-and-pull workflow to add a
1010

1111
Pushing to the `build` branch lets you preview the build output using Netlify. You must log into Netlify to view the preview deploy.
1212

13-
Pushing to the `master` branch builds output to https://www.docslikecode.com using Netlify. Auto publishing is on as a setting in Netlify, so deploys from master are published automatically.
13+
Pushing to the `main` branch builds output to https://www.docslikecode.com using Netlify. Auto publishing is on as a setting in Netlify, so deploys from `main` are published automatically.
1414

1515
## Theme Colophon
1616
Theme courtesy of https://mmistakes.github.io/so-simple-theme/

_data/authors.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
anne_gentle:
44
name: Anne Gentle
5-
picture: http://docslikecode.com/images/anne_gentle.jpg
5+
picture: https://docslikecode.com/images/anne_gentle.jpg
66
github: //github.com/annegentle
77
twitter: annegentle
88
bio: "Developer Experience Manager"

_learn/01-sphinx-python-rtd.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ image:
66
caption: "Python and Sphinx"
77
---
88

9-
Sphinx works with either major versions of Python active today, Python 2 and Python 3. Python 3 is the current and recommended version, and Python 2 is an unsupported Python version. Sphinx is a documentation tool that creates HTML, CSS, and JavaScript files from [ReStructured](http://docutils.sourceforge.net/rst.html) text files.
9+
Sphinx works with either major versions of Python active today, Python 2 and Python 3. Python 3 is the current and recommended version, and Python 2 is an unsupported Python version. Sphinx is a documentation tool that creates HTML, CSS, and JavaScript files from [ReStructured](https://docutils.sourceforge.net/rst.html) text files.
1010

1111
In case you need both versions, refer to the [Downloads on the Python site](https://www.python.org/downloads/).
1212

@@ -89,7 +89,7 @@ Most people use Virtual Environments because it's a recommended practice when wo
8989
9090
## Create a Basic Sphinx Project
9191
92-
You can also get familiar with [ReStructured text](http://docutils.sourceforge.net/docs/user/rst/quickstart.html), a plain text markup syntax system that you use to write content in Sphinx documentation. Sphinx can also accept [Markdown](https://commonmark.org/help/) files.
92+
You can also get familiar with [ReStructured text](https://docutils.sourceforge.net/docs/user/rst/quickstart.html), a plain text markup syntax system that you use to write content in Sphinx documentation. Sphinx can also accept [Markdown](https://commonmark.org/help/) files.
9393
9494
1. Create a new directory for your project:
9595
```
@@ -151,4 +151,4 @@ You can also get familiar with [ReStructured text](http://docutils.sourceforge.n
151151
## Additional references
152152
153153
* [Sphinx Python Documentation Generator](https://www.sphinx-doc.org/en/stable/)
154-
* [ReStructured text documentation](http://docutils.sourceforge.net/rst.html)
154+
* [ReStructured text documentation](https://docutils.sourceforge.net/rst.html)

_learn/05-cd-for-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ You can also deploy documentation sites using free hosting options as alternativ
116116
## Additional references
117117

118118
* [TravisCI Core Concepts for Beginners](https://docs.travis-ci.com/user/for-beginners)
119-
* [Convert AsciiDoc to HTML/PDF & publish to GitHub Pages with Travis CI and Asciidoctor Docker containers](http://mgreau.com/posts/2016/03/28/asciidoc-to-gh-pages-with-travis-ci-docker-asciidoctor.html)
119+
* [Convert AsciiDoc to HTML/PDF & publish to GitHub Pages with Travis CI and Asciidoctor Docker containers](https://mgreau.com/posts/2016/03/28/asciidoc-to-gh-pages-with-travis-ci-docker-asciidoctor.html)

_learn/11-print-pdf-epub-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ How difficult or straightforward is it to create a print or PDF format? You may
1010

1111
### Jekyll options
1212

13-
In the Jekyll Documentation Theme site, Tom Johnson suggests buying a license for Prince XML ($500) in order to create print-ready PDF files with the [Jekyll Documentation Theme](https://idratherbewriting.com/documentation-theme-jekyll/). The PDF layout and styles are set using CSS. Considering that the only gem solution, [jekyll-pdf](https://github.com/abeMedia/jekyll-pdf), makes PDF files of single pages rather than a collection, the third-party solution is probably the way to go. You could look into the [Open-Publisher](https://github.com/chrisanthropic/Open-Publisher) project, which is using Jekyll to create outputs that can be used as Pandoc inputs. [Pandoc](http://pandoc.org/) is a super handy conversion tool that can convert many formats to other formats, and has templating capabilities that can help.
13+
In the Jekyll Documentation Theme site, Tom Johnson suggests buying a license for Prince XML ($500) in order to create print-ready PDF files with the [Jekyll Documentation Theme](https://idratherbewriting.com/documentation-theme-jekyll/). The PDF layout and styles are set using CSS. Considering that the only gem solution, [jekyll-pdf](https://github.com/abeMedia/jekyll-pdf), makes PDF files of single pages rather than a collection, the third-party solution is probably the way to go. You could look into the [Open-Publisher](https://github.com/chrisanthropic/Open-Publisher) project, which is using Jekyll to create outputs that can be used as Pandoc inputs. [Pandoc](https://pandoc.org/) is a super handy conversion tool that can convert many formats to other formats, and has templating capabilities that can help.
1414

1515
### Sphinx options
1616

_posts/articles/2016-11-26-remodel-your-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here are some resources to get your first punch in that punch list:
4242

4343
* Using Python Sphinx? The OpenStack docs theme has some Javascript you could re-use to pre-populate an Issue template so the reporter sends the page URL, the source URL, the git SHA of the commit for that version of the page, and the release version value. See this [docs.js snippet](https://github.com/openstack/openstackdocstheme/blob/master/openstackdocstheme/theme/openstackdocs/static/js/docs.js#L119).
4444
* Using a private repo for docs, but want to track bugs publicly? Use [Issues-only Access Permissions](https://help.github.com/articles/issues-only-access-permissions/).
45-
* Want to add a bit of code to pre-create Issues to use as comments on every page? Free yourself from Disqus comments. Try this [set of tips and sample code in a blog post](http://zpbappi.com/jekyll-with-tags-archive-and-comments-in-github-pages/).
45+
* Want to add a bit of code to pre-create Issues to use as comments on every page? Free yourself from Disqus comments. Try this [set of tips and sample code in a blog post](https://zpbappi.com/jekyll-with-tags-archive-and-comments-in-github-pages/).
4646

4747

4848
{% include sign-up.html %}

_posts/articles/2017-04-04-balsamiq-case-study-part-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For the next update to our docs, we decided that we needed to finally address th
5151

5252
But, of course, we didn't want to maintain seven copies of each article. We wanted to be able to write the docs once and have them show up across multiple versions.
5353

54-
A simple solution, I suppose, would have been to switch from Markdown to a file format that supports including content from one file in another (like [reStructuredText](http://docutils.sourceforge.net/rst.html) or [AsciiDoc](http://asciidoc.org/)). **But, I'm stubborn** (and Hugo doesn't support them well). I like how simple Markdown is and I wanted to see if we could achieve what we wanted without abandoning it.
54+
A simple solution, I suppose, would have been to switch from Markdown to a file format that supports including content from one file in another (like [reStructuredText](https://docutils.sourceforge.net/rst.html) or [AsciiDoc](https://asciidoc.org/)). **But, I'm stubborn** (and Hugo doesn't support them well). I like how simple Markdown is and I wanted to see if we could achieve what we wanted without abandoning it.
5555

5656
I enlisted the help of our resident [Go](https://golang.org/) expert, [Luis](https://balsamiq.com/company/#luis), and he wrote some code to do just what we wanted. This code inside one of the Hugo templates allowed us to put help files in two hidden folders (called "\_v2" and "\_v3") that would get injected into files across multiple documentation folders each time the site was generated. The end result was that users could now find the information where they expected to find it.
5757

_posts/articles/2017-04-09-balsamiq-case-study-part-2.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,16 @@ But it can be distracting to read an article when there's an endlessly-looping a
3131

3232
I came across several sites that gave users an option to play the animated GIF when they clicked on it and I thought that would be great for our docs.
3333

34-
I found a great jquery plugin that I wanted to use called [**gifplayer**](http://rubentd.com/gifplayer/).
34+
I found a great jquery plugin that I wanted to use called [**gifplayer**](https://rubentd.com/gifplayer/).
3535

36-
[![You know you want to click](https://media.balsamiq.com/images/docslikecode/gifplayer.png)](http://rubentd.com/gifplayer/).
36+
[![You know you want to click](https://media.balsamiq.com/images/docslikecode/gifplayer.png)](https://rubentd.com/gifplayer/).
3737

3838
There was just one problem. Markdown. Again.
3939

4040
Triggering the gifplayer code is as easy as adding a CSS class to an image. Like this:
4141

4242
```html
43-
<img class="gif" src="http://rubentd.com/img/banana.png">
43+
<img class="gif" src="https://rubentd.com/img/banana.png">
4444
```
4545

4646
But native Markdown doesn't support adding CSS. Of course, Markdown *does* support inline HTML, and we *could* have just written HTML whenever we wanted to add an animated GIF. But, again, **I'm stubborn**. I like my Markdown to be clean. I didn't want to go down a slippery slope of adding special cases for departing from pure Markdown.
@@ -60,11 +60,11 @@ Like this:
6060
So, now, if we write:
6161

6262
```markdown
63-
![gif](http://rubentd.com/img/banana.png)
63+
![gif](https://rubentd.com/img/banana.png)
6464
```
6565
it triggers the gifplayer script!
6666

67-
![party](http://rubentd.com/img/banana.gif)
67+
![party](https://rubentd.com/img/banana.gif)
6868

6969
Sorry, we didn't implement the pause/play capability on this site, so that banana is gonna keep on dancing. You can see the pause/play solution in action on our Balsamiq article on [common workarounds](https://support.balsamiq.com/tutorials/workarounds/#link-to-alternates).
7070

_posts/articles/2017-04-15-balsamiq-case-study-part-3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A big ol' list of links. A wall of text. It's a very different feel from the pag
3535

3636
It's clear to me that this page is automatically generated by some kind of content management system (CMS) template. Designers for pages like this usually cede control of the placement of the articles to the CMS, because they don't want to have to manually update it every time a new article is added.
3737

38-
They're limited because they don't know how many articles there will be in each category, so most sites just end up creating a simple list, perhaps in sub-categories. Even awesome documentation sites like [Mailchimp](http://kb.mailchimp.com/) and [Zapier](https://zapier.com/help/) do this once you go beyond the first level.
38+
They're limited because they don't know how many articles there will be in each category, so most sites just end up creating a simple list, perhaps in sub-categories. Even awesome documentation sites like [Mailchimp](https://kb.mailchimp.com/) and [Zapier](https://zapier.com/help/) do this once you go beyond the first level.
3939

4040
And this is exactly what we do on our documentation site within each product category currently:
4141

@@ -51,7 +51,7 @@ It feels more like a documentation site landing page, right? It has a featured a
5151

5252
I'll start by explaining the "Everything Else..." section at the bottom and what makes it different from our previous version.
5353

54-
The links there are automatically placed by Hugo and styled using the [Bootstrap List group](http://getbootstrap.com/components/#list-group) component. That part is pretty easy. The challenge was putting them in columns and making sure that the columns were equal heights, regardless of how many articles there were.
54+
The links there are automatically placed by Hugo and styled using the [Bootstrap List group](https://getbootstrap.com/components/#list-group) component. That part is pretty easy. The challenge was putting them in columns and making sure that the columns were equal heights, regardless of how many articles there were.
5555

5656
Here's the code I wrote inside the Hugo template to define some variables to use further down in the code:
5757

@@ -104,7 +104,7 @@ I wanted different images for each of the featured articles, but I just didn't l
104104

105105
{% raw %}
106106
```html
107-
<img src="http://media.balsamiq.com/img/support/docs/m4d/b3/toc-button-{{ .File.BaseFileName }}.svg">
107+
<img src="https://media.balsamiq.com/img/support/docs/m4d/b3/toc-button-{{ .File.BaseFileName }}.svg">
108108
```
109109
{% endraw %}
110110

_posts/articles/2017-06-03-api-docs-with-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,11 @@ namespace LinkInterface
104104
}
105105
```
106106

107-
After enabling these options, I *could* include code that enables the Swagger UI, but that interface looks a bit outdated. Also, I want to incorporate additional documentation written in Markdown, which the Swagger UI does not support. After reading online forums and posting questions to the [Write The Docs channel on Slack](http://www.writethedocs.org/slack/), I discovered DapperDox.
107+
After enabling these options, I *could* include code that enables the Swagger UI, but that interface looks a bit outdated. Also, I want to incorporate additional documentation written in Markdown, which the Swagger UI does not support. After reading online forums and posting questions to the [Write The Docs channel on Slack](https://www.writethedocs.org/slack/), I discovered DapperDox.
108108
109109
## Using DapperDox
110110

111-
[DapperDox](http://dapperdox.io/) is an open source documentation framework for OpenAPI specifications. Instead of having Swashbuckle publish our API specification in the Swagger UI, I added the following code to the `Startup.cs` file. This code writes the Swagger specification to a `swagger.json` file.
111+
[DapperDox](https://dapperdox.io/) is an open source documentation framework for OpenAPI specifications. Instead of having Swashbuckle publish our API specification in the Swagger UI, I added the following code to the `Startup.cs` file. This code writes the Swagger specification to a `swagger.json` file.
112112
113113
```csharp
114114
System.IO.StreamWriter file = new System.IO.StreamWriter("swagger.json");
@@ -118,7 +118,7 @@ After enabling these options, I *could* include code that enables the Swagger UI
118118

119119
DapperDox reads this file and displays it in its own UI. I installed DapperDox and pointed it at my `swagger.json` file, and saw nothing but error messages in my command prompt.
120120

121-
Reading through the [DapperDox documentation](http://dapperdox.io/docs/spec-resource-definitions), I discovered that *"When specifying a resource schema object...DapperDox requires that the optional schema object title member is present."* This requirement was problematic, because Swashbuckle does not include a method for adding members to a schema in the generated `swagger.json` file. Additionally, it took some tinkering in the code for me to realize that the missing title member on the `definitions` model is what caused DapperDox to break.
121+
Reading through the [DapperDox documentation](https://dapperdox.io/docs/spec-resource-definitions), I discovered that *"When specifying a resource schema object...DapperDox requires that the optional schema object title member is present."* This requirement was problematic, because Swashbuckle does not include a method for adding members to a schema in the generated `swagger.json` file. Additionally, it took some tinkering in the code for me to realize that the missing title member on the `definitions` model is what caused DapperDox to break.
122122
123123
## Fixing the output
124124

0 commit comments

Comments
 (0)