From 414c2236fe47d2cb282affe956b5ccb409a1dca7 Mon Sep 17 00:00:00 2001 From: Casey Brooks Date: Sun, 30 Sep 2018 21:46:34 -0500 Subject: [PATCH 1/4] Updates URLs to use HTTPS when possible --- .../src/main/resources/templates/server/404.peb | 2 +- .../resources/templates/server/directoryListing.peb | 4 ++-- .../pages/bundles/OrchidLanguagePack/index.md | 4 ++-- .../resources/pages/plugins/OrchidAsciidoc/index.md | 2 +- .../resources/pages/plugins/OrchidBible/index.md | 6 +++--- .../resources/pages/plugins/OrchidChangelog/index.md | 2 +- .../resources/pages/plugins/OrchidDiagrams/index.md | 2 +- .../resources/pages/plugins/OrchidForms/index.md | 2 +- .../resources/pages/plugins/OrchidJavadoc/index.md | 2 +- .../resources/pages/plugins/OrchidKSS/index.md | 4 ++-- .../resources/pages/plugins/OrchidKotlindoc/index.md | 2 +- .../pages/plugins/OrchidNetlifyCMS/index.md | 2 +- .../pages/plugins/OrchidPluginDocs/index.md | 2 +- .../resources/pages/plugins/OrchidPosts/index.md | 2 +- .../pages/plugins/OrchidPresentations/index.md | 2 +- .../resources/pages/plugins/OrchidSearch/index.md | 2 +- .../resources/pages/plugins/OrchidSwagger/index.md | 2 +- .../resources/pages/plugins/OrchidSwiftdoc/index.md | 2 +- .../pages/plugins/OrchidSyntaxHighlighter/index.md | 2 +- .../pages/plugins/OrchidTaxonomies/index.md | 2 +- .../resources/pages/plugins/OrchidWiki/index.md | 2 +- .../pages/plugins/OrchidWritersBlocks/index.md | 2 +- .../resources/pages/themes/OrchidBsDoc/index.md | 12 ++++++------ .../resources/pages/themes/OrchidEditorial/index.md | 8 ++++---- .../pages/themes/OrchidFutureImperfect/index.md | 10 +++++----- .../templates/components/homepage-staggered-list.peb | 2 +- .../resources/templates/includes/copyright.peb | 2 +- .../resources/wiki/developers-guide/overview.md | 4 ++-- .../user-manual/building-blocks/linking-to-pages.md | 2 +- .../resources/wiki/user-manual/themes/pebble.md | 2 +- .../src/main/resources/assets/css/orchidJavadoc.scss | 6 +++--- .../main/resources/assets/css/orchidSwiftdoc.scss | 6 +++--- .../src/main/resources/assets/css/_docs.scss | 4 ++-- .../main/resources/templates/includes/copyright.peb | 2 +- .../src/main/resources/templates/includes/footer.peb | 2 +- 35 files changed, 58 insertions(+), 58 deletions(-) diff --git a/OrchidCore/src/main/resources/templates/server/404.peb b/OrchidCore/src/main/resources/templates/server/404.peb index 9090324f36..aae0da4589 100644 --- a/OrchidCore/src/main/resources/templates/server/404.peb +++ b/OrchidCore/src/main/resources/templates/server/404.peb @@ -41,6 +41,6 @@ - + \ No newline at end of file diff --git a/OrchidCore/src/main/resources/templates/server/directoryListing.peb b/OrchidCore/src/main/resources/templates/server/directoryListing.peb index c17b7c24ee..1129fbdb35 100644 --- a/OrchidCore/src/main/resources/templates/server/directoryListing.peb +++ b/OrchidCore/src/main/resources/templates/server/directoryListing.peb @@ -105,7 +105,7 @@ - - + + \ No newline at end of file diff --git a/OrchidCore/src/orchid/resources/pages/bundles/OrchidLanguagePack/index.md b/OrchidCore/src/orchid/resources/pages/bundles/OrchidLanguagePack/index.md index 7240f568ad..39ecfbb34c 100644 --- a/OrchidCore/src/orchid/resources/pages/bundles/OrchidLanguagePack/index.md +++ b/OrchidCore/src/orchid/resources/pages/bundles/OrchidLanguagePack/index.md @@ -17,9 +17,9 @@ The Orchid Language Pack bundle is not a ready-to-use bundle, but does group tog improve your composing and documenting experience. All official Orchid plugins which add new Compilers, markup your page content, or otherwise extend the language capabilities of your Orchid site are bundled here. Some examples include: -* Compile your pages with [Asciidoctor](http://asciidoctor.org/docs/asciidoctorj/) by using the `.ad` or `.asciidoc` +* Compile your pages with [Asciidoctor](https://asciidoctor.org/docs/asciidoctorj/) by using the `.ad` or `.asciidoc` file extension * Add syntax highlighting to your code snippets. Choose from static highlighting with -[Pygments](http://pygments.org/docs/java/), or browser-side highlighting with [Prism.js](http://prismjs.com/). +[Pygments](http://pygments.org/docs/java/), or browser-side highlighting with [Prism.js](https://prismjs.com/). * Load the text of Bible verse references automatically. Choose from static references loading with a Markdown extension, or use the [Faithlife Reftagger.js](https://reftagger.com) to load verses on-demand. diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidAsciidoc/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidAsciidoc/index.md index 8b5a19ebe0..c6ca24d066 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidAsciidoc/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidAsciidoc/index.md @@ -3,7 +3,7 @@ official: true noDocs: true description: Compile your content using Asciidoctor. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/asciidoc.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/asciidoc.jpg alt: Asciidoc caption: Photo by Markus Spiske on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidBible/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidBible/index.md index 1314482469..61430fb9fc 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidBible/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidBible/index.md @@ -3,7 +3,7 @@ official: true noDocs: true description: Load the full text of Bible verses quickly and easily. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/bible.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/bible.jpg alt: Bible caption: Photo by Priscilla Du Preez on Unsplash --- @@ -12,8 +12,8 @@ images: Bible verses can be added simply by passing their reference to the `bible` function. The verse text will be downloaded and displayed on the page, along with the verse reference. You will need to sign up for an API key for the -[Bibles.org API](http://www.bibles.org/pages/api) to download verse text, and the Bible version must be the `id` of one -of the [available versions on Bibles.org](http://www.bibles.org/versions_api). +[Bibles.org API](https://www.bibles.org/pages/api) to download verse text, and the Bible version must be the `id` of one +of the [available versions on Bibles.org](https://www.bibles.org/versions_api). As a filter diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidChangelog/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidChangelog/index.md index 44af42200d..4dcc1acc6b 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidChangelog/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidChangelog/index.md @@ -2,7 +2,7 @@ official: true description: Track and discover changes across the various versions of your library or application. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974267/plugins/changelog.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974267/plugins/changelog.jpg alt: Changelog caption: Photo by Baron Fig on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidDiagrams/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidDiagrams/index.md index 901b64beca..cfe592b08f 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidDiagrams/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidDiagrams/index.md @@ -3,7 +3,7 @@ official: true noDocs: true description: Create flowcharts and sequence diagrams using the PlantUML markup language. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974867/plugins/diagrams.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974867/plugins/diagrams.jpg alt: Diagrams caption: Photo by William Iven on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidForms/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidForms/index.md index 362098fb19..0b886614fb 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidForms/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidForms/index.md @@ -2,7 +2,7 @@ official: true description: Engage your users with embeddable, fully customizable forms. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974798/plugins/forms.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974798/plugins/forms.jpg alt: Forms caption: Photo by Gemma Evans on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidJavadoc/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidJavadoc/index.md index 9067ea9aad..14dddf9e79 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidJavadoc/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidJavadoc/index.md @@ -2,7 +2,7 @@ official: true description: Where Orchid began. Create beautiful Javadocs for your project within your Orchid site. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974952/plugins/javadoc.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974952/plugins/javadoc.jpg alt: Javadoc caption: Photo by Brooke Lark on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidKSS/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidKSS/index.md index d4ab1f45aa..6097fc8944 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidKSS/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidKSS/index.md @@ -2,14 +2,14 @@ official: true description: Generate a living styleguide from annotated CSS, Sass, Scss, or LESS images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974377/plugins/styleguide.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974377/plugins/styleguide.jpg alt: KSS Styleguide caption: Photo by Jan Losert on Unsplash --- ### Using Orchid KSS -[KSS](http://warpspire.com/kss/syntax/) is a methodology for documenting your CSS and generating a styleguide which +[KSS](https://warpspire.com/kss/syntax/) is a methodology for documenting your CSS and generating a styleguide which shows example usage of your stylesheets. This plugin implements a basic KSS parser and renders KSS blocks as Orchid pages. KSS are block comments placed within your stylesheets, an example is given below: diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidKotlindoc/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidKotlindoc/index.md index 62782afe3b..8abbdc6822 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidKotlindoc/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidKotlindoc/index.md @@ -2,7 +2,7 @@ official: true description: Embed Kotlin and Java documentation in your Orchid site using Dokka. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974952/plugins/javadoc.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974952/plugins/javadoc.jpg alt: Javadoc caption: Photo by Brooke Lark on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidNetlifyCMS/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidNetlifyCMS/index.md index 639cc90e2a..d4413c8f7b 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidNetlifyCMS/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidNetlifyCMS/index.md @@ -2,7 +2,7 @@ official: true description: No configuration, fully-featured Netlify CMS for Orchid. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974475/plugins/netlifycms.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974475/plugins/netlifycms.jpg alt: Netlify CMS caption: Screenshot of Netlify CMS --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPluginDocs/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPluginDocs/index.md index 2ed7980143..6b08d2846c 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPluginDocs/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPluginDocs/index.md @@ -2,7 +2,7 @@ official: true description: Auto-generate your plugin's documentation, plus a handy admin panel to bring your plugins documentation to you. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974694/plugins/plugindocs.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974694/plugins/plugindocs.jpg alt: Plugin Docs caption: Photo by Daniel McCullough on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPosts/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPosts/index.md index acea2ac68b..5d2b70fdab 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPosts/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPosts/index.md @@ -2,7 +2,7 @@ official: true description: Add Jekyll-like blogging functionality to your Orchid site. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/posts.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/posts.jpg alt: Posts caption: Photo by Emma Matthews on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPresentations/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPresentations/index.md index e22b7735db..208f5e3fb6 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidPresentations/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidPresentations/index.md @@ -2,7 +2,7 @@ official: true description: Embed slide presentations in your site using Deck.js images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974588/plugins/presentations.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524974588/plugins/presentations.jpg alt: Presentations caption: Photo by rawpixel.com on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSearch/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSearch/index.md index ed563fef8e..5f5dc35f64 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSearch/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSearch/index.md @@ -2,7 +2,7 @@ official: true description: Add static full-text search with Lunr.js to any Orchid site images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/search.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/search.jpg alt: Search caption: Photo by Louis Blythe on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwagger/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwagger/index.md index af7d24e692..f6955fef59 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwagger/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwagger/index.md @@ -2,7 +2,7 @@ official: true description: Embed the Swagger UI within any Orchid page. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/swagger.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/swagger.jpg alt: Swagger caption: Screenshot of Swagger UI --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwiftdoc/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwiftdoc/index.md index e2515f7ffa..07382c3b08 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwiftdoc/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSwiftdoc/index.md @@ -2,7 +2,7 @@ official: true description: Create beautiful documentation for your Swift source code within Orchid. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1525466545/plugins/swiftdoc.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1525466545/plugins/swiftdoc.jpg alt: Swiftdoc caption: Photo by OOI JIET on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSyntaxHighlighter/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSyntaxHighlighter/index.md index 11f0188446..c99d472d3f 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidSyntaxHighlighter/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidSyntaxHighlighter/index.md @@ -3,7 +3,7 @@ official: true noDocs: true description: Add syntax highlighting with Pygments or PrismJS. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/syntaxhighlighter.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973700/plugins/syntaxhighlighter.jpg alt: Syntax Highlighter caption: Photo by William Iven on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidTaxonomies/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidTaxonomies/index.md index f080ea625b..46b58f09bc 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidTaxonomies/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidTaxonomies/index.md @@ -2,7 +2,7 @@ official: true description: Tag your pages with custom taxonomies and generate archives and landing pages for your taxonomy groups. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/taxonomies.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/taxonomies.jpg alt: Taxonomies caption: Photo by Louie Martinez on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidWiki/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidWiki/index.md index 930b43f323..689c6ef9f2 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidWiki/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidWiki/index.md @@ -2,7 +2,7 @@ official: true description: A Gitbook-like wiki for your Orchid site. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/wiki.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/wiki.jpg alt: Wiki caption: Photo by Patrick Tomasso on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/plugins/OrchidWritersBlocks/index.md b/OrchidCore/src/orchid/resources/pages/plugins/OrchidWritersBlocks/index.md index ee07406c8f..501c7205b5 100644 --- a/OrchidCore/src/orchid/resources/pages/plugins/OrchidWritersBlocks/index.md +++ b/OrchidCore/src/orchid/resources/pages/plugins/OrchidWritersBlocks/index.md @@ -3,7 +3,7 @@ official: true noDocs: true description: A collection of Template Tags and Components that help you get past the writer's block and make building your site a dream. images: - - src: http://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/writersblocks.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_scale,w_300,e_blur:150/v1524973072/plugins/writersblocks.jpg alt: Writer's Blocks caption: Photo by Ilario Piatti on Unsplash --- diff --git a/OrchidCore/src/orchid/resources/pages/themes/OrchidBsDoc/index.md b/OrchidCore/src/orchid/resources/pages/themes/OrchidBsDoc/index.md index d22af8b9c5..6aadbe769d 100644 --- a/OrchidCore/src/orchid/resources/pages/themes/OrchidBsDoc/index.md +++ b/OrchidCore/src/orchid/resources/pages/themes/OrchidBsDoc/index.md @@ -1,20 +1,20 @@ --- official: true -thumbnail: http://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524971822/themes/bsdoc/1.jpg +thumbnail: https://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524971822/themes/bsdoc/1.jpg images: - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/1.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/1.jpg alt: Homepage caption: Homepage - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/2.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/2.jpg alt: Post Layout caption: Post Layout - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/3.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/3.jpg alt: Wiki Summary and Search caption: Wiki Summary and Search - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/4.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/4.jpg alt: Documentation caption: Documentation - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/5.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524971822/themes/bsdoc/5.jpg alt: Javadocs caption: Javadocs --- \ No newline at end of file diff --git a/OrchidCore/src/orchid/resources/pages/themes/OrchidEditorial/index.md b/OrchidCore/src/orchid/resources/pages/themes/OrchidEditorial/index.md index e1f93786a2..56dd5dfce8 100644 --- a/OrchidCore/src/orchid/resources/pages/themes/OrchidEditorial/index.md +++ b/OrchidCore/src/orchid/resources/pages/themes/OrchidEditorial/index.md @@ -1,14 +1,14 @@ --- official: true -thumbnail: http://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524970938/themes/editorial/1.jpg +thumbnail: https://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524970938/themes/editorial/1.jpg images: - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/1.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/1.jpg alt: Homepage caption: Homepage - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/2.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/2.jpg alt: Post Layout caption: Post Layout - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/3.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524970938/themes/editorial/3.jpg alt: Search caption: Search --- diff --git a/OrchidCore/src/orchid/resources/pages/themes/OrchidFutureImperfect/index.md b/OrchidCore/src/orchid/resources/pages/themes/OrchidFutureImperfect/index.md index f98eb2ea11..28b094527a 100644 --- a/OrchidCore/src/orchid/resources/pages/themes/OrchidFutureImperfect/index.md +++ b/OrchidCore/src/orchid/resources/pages/themes/OrchidFutureImperfect/index.md @@ -1,17 +1,17 @@ --- official: true -thumbnail: http://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524969542/themes/futureimperfect/1.jpg +thumbnail: https://res.cloudinary.com/orchid/image/upload/c_fit,h_200,w_400/v1524969542/themes/futureimperfect/1.jpg images: - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/1.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/1.jpg alt: Homepage caption: Homepage - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/2.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/2.jpg alt: Post Layout caption: Post Layout - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/3.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/3.jpg alt: Search caption: Search - - src: http://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/4.jpg + - src: https://res.cloudinary.com/orchid/image/upload/c_fit,h_600,w_800/v1524969542/themes/futureimperfect/4.jpg alt: Sidebar caption: Sidebar --- diff --git a/OrchidCore/src/orchid/resources/templates/components/homepage-staggered-list.peb b/OrchidCore/src/orchid/resources/templates/components/homepage-staggered-list.peb index b46a17050d..401d8bd3a4 100644 --- a/OrchidCore/src/orchid/resources/templates/components/homepage-staggered-list.peb +++ b/OrchidCore/src/orchid/resources/templates/components/homepage-staggered-list.peb @@ -25,7 +25,7 @@ Orchid ships with Markdown, SCSS, and - Pebble compilers built-in, which make + Pebble compilers built-in, which make designing your site and managing your content a breeze, with additional languages like Asciidoctor available as plugins. Orchid also has features like full-text static search, a modular architecture with component-based design system, integration with the diff --git a/OrchidCore/src/orchid/resources/templates/includes/copyright.peb b/OrchidCore/src/orchid/resources/templates/includes/copyright.peb index ded313652a..808f25c4e1 100644 --- a/OrchidCore/src/orchid/resources/templates/includes/copyright.peb +++ b/OrchidCore/src/orchid/resources/templates/includes/copyright.peb @@ -4,7 +4,7 @@

Documentation template based on the Jekyll Bootstrap Doc - Jekyll theme by the Bootstrap team. Site created with + Jekyll theme by the Bootstrap team. Site created with Orchid.

{% if theme.showVersion %} diff --git a/OrchidCore/src/orchid/resources/wiki/developers-guide/overview.md b/OrchidCore/src/orchid/resources/wiki/developers-guide/overview.md index d6aa49d3f7..d45bf6c525 100644 --- a/OrchidCore/src/orchid/resources/wiki/developers-guide/overview.md +++ b/OrchidCore/src/orchid/resources/wiki/developers-guide/overview.md @@ -183,10 +183,10 @@ with the Orchid plugins that came from this inspiration. - {{ anchor('Orchid Posts') }} - [**Gitbook**](https://toolchain.gitbook.com/) - {{ anchor('Orchid Wiki') }} -- [**Javadoc**](http://www.oracle.com/technetwork/java/javase/tech/index-jsp-135444.html) +- [**Javadoc**](https://www.oracle.com/technetwork/java/javase/tech/index-jsp-135444.html) - {{ anchor('Orchid Javadoc') }} - {{ anchor('Orchid Swiftdoc') }} -- [**SC5 Styleguide**](http://styleguide.sc5.io/) +- [**SC5 Styleguide**](https://styleguide.sc5.io/) - {{ anchor('Orchid KSS') }} {% endblock %} \ No newline at end of file diff --git a/OrchidCore/src/orchid/resources/wiki/user-manual/building-blocks/linking-to-pages.md b/OrchidCore/src/orchid/resources/wiki/user-manual/building-blocks/linking-to-pages.md index 014d50be39..1a17d3235c 100644 --- a/OrchidCore/src/orchid/resources/wiki/user-manual/building-blocks/linking-to-pages.md +++ b/OrchidCore/src/orchid/resources/wiki/user-manual/building-blocks/linking-to-pages.md @@ -90,7 +90,7 @@ This function only matches items if they are an {{anchor('OrchidPage')}}. {% highlight 'jinja' %} {% verbatim %} -{{ link(['itemId', 'collectionId', 'collectionType']) -> http://orchid.netlify.com/... }} +{{ link(['itemId', 'collectionId', 'collectionType']) -> https://orchid.netlify.com/... }} {{ link(itemId='itemId', collectionId='collectionId', collectionType='collectionType') }} {% endverbatim %} {% endhighlight %} diff --git a/OrchidCore/src/orchid/resources/wiki/user-manual/themes/pebble.md b/OrchidCore/src/orchid/resources/wiki/user-manual/themes/pebble.md index 3805654195..b8fcec6e28 100644 --- a/OrchidCore/src/orchid/resources/wiki/user-manual/themes/pebble.md +++ b/OrchidCore/src/orchid/resources/wiki/user-manual/themes/pebble.md @@ -1,5 +1,5 @@ --- -pebbleUrl: 'http://www.mitchellbosecke.com/pebble/documentation' +pebbleUrl: 'https://github.com/PebbleTemplates/pebble/wiki' --- {% extends '_wikiBase' %} diff --git a/plugins/OrchidJavadoc/src/main/resources/assets/css/orchidJavadoc.scss b/plugins/OrchidJavadoc/src/main/resources/assets/css/orchidJavadoc.scss index fe2ae6ad2b..c6039f2604 100644 --- a/plugins/OrchidJavadoc/src/main/resources/assets/css/orchidJavadoc.scss +++ b/plugins/OrchidJavadoc/src/main/resources/assets/css/orchidJavadoc.scss @@ -1,15 +1,15 @@ /*! - * Bootstrap v3.3.7 (http://getbootstrap.com) + * Bootstrap v3.3.7 (https://getbootstrap.com) * Copyright 2011-2018 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */ /*! - * Generated using the Bootstrap Customizer (http://getbootstrap.com/docs/3.3/customize/?id=c78cd796ed3d630f903dec748e113244) + * Generated using the Bootstrap Customizer (https://getbootstrap.com/docs/3.3/customize/?id=c78cd796ed3d630f903dec748e113244) * Config saved to config.json and https://gist.github.com/c78cd796ed3d630f903dec748e113244 */ /*! - * Bootstrap v3.3.7 (http://getbootstrap.com) + * Bootstrap v3.3.7 (https://getbootstrap.com) * Copyright 2011-2016 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */ diff --git a/plugins/OrchidSwiftdoc/src/main/resources/assets/css/orchidSwiftdoc.scss b/plugins/OrchidSwiftdoc/src/main/resources/assets/css/orchidSwiftdoc.scss index fe2ae6ad2b..c6039f2604 100644 --- a/plugins/OrchidSwiftdoc/src/main/resources/assets/css/orchidSwiftdoc.scss +++ b/plugins/OrchidSwiftdoc/src/main/resources/assets/css/orchidSwiftdoc.scss @@ -1,15 +1,15 @@ /*! - * Bootstrap v3.3.7 (http://getbootstrap.com) + * Bootstrap v3.3.7 (https://getbootstrap.com) * Copyright 2011-2018 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */ /*! - * Generated using the Bootstrap Customizer (http://getbootstrap.com/docs/3.3/customize/?id=c78cd796ed3d630f903dec748e113244) + * Generated using the Bootstrap Customizer (https://getbootstrap.com/docs/3.3/customize/?id=c78cd796ed3d630f903dec748e113244) * Config saved to config.json and https://gist.github.com/c78cd796ed3d630f903dec748e113244 */ /*! - * Bootstrap v3.3.7 (http://getbootstrap.com) + * Bootstrap v3.3.7 (https://getbootstrap.com) * Copyright 2011-2016 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */ diff --git a/themes/OrchidBsDoc/src/main/resources/assets/css/_docs.scss b/themes/OrchidBsDoc/src/main/resources/assets/css/_docs.scss index 1e8fc49107..0013ca52df 100644 --- a/themes/OrchidBsDoc/src/main/resources/assets/css/_docs.scss +++ b/themes/OrchidBsDoc/src/main/resources/assets/css/_docs.scss @@ -1,10 +1,10 @@ @import "vars"; /*! - * Bootstrap Docs (http://getbootstrap.com) + * Bootstrap Docs (https://getbootstrap.com) * Copyright 2011-2014 Twitter, Inc. * Licensed under the Creative Commons Attribution 3.0 Unported License. For - * details, see http://creativecommons.org/licenses/by/3.0/. + * details, see https://creativecommons.org/licenses/by/3.0/. */ body { diff --git a/themes/OrchidBsDoc/src/main/resources/templates/includes/copyright.peb b/themes/OrchidBsDoc/src/main/resources/templates/includes/copyright.peb index 4d8a1268db..c4d16a91d7 100644 --- a/themes/OrchidBsDoc/src/main/resources/templates/includes/copyright.peb +++ b/themes/OrchidBsDoc/src/main/resources/templates/includes/copyright.peb @@ -1,7 +1,7 @@

Documentation template based on the Jekyll Bootstrap Doc - Jekyll theme by the Bootstrap team. Site created with + Jekyll theme by the Bootstrap team. Site created with Orchid.

{% if theme.showVersion %} diff --git a/themes/OrchidFutureImperfect/src/main/resources/templates/includes/footer.peb b/themes/OrchidFutureImperfect/src/main/resources/templates/includes/footer.peb index 9f0b811dde..503a281042 100644 --- a/themes/OrchidFutureImperfect/src/main/resources/templates/includes/footer.peb +++ b/themes/OrchidFutureImperfect/src/main/resources/templates/includes/footer.peb @@ -9,7 +9,7 @@

© {{ site.about.siteName }}. - Design by HTML5 UP. + Design by HTML5 UP. Created with Orchid.

\ No newline at end of file From a0bf6155bc1b7e1a3df8aca57402820ee43ee2d9 Mon Sep 17 00:00:00 2001 From: Casey Brooks Date: Mon, 1 Oct 2018 15:57:30 -0500 Subject: [PATCH 2/4] Fixes many of the broken links due to stale anchor/linking functions data. Changes standard ordering of collection search params --- .../orchid/api/indexing/IndexService.java | 2 +- .../orchid/api/indexing/IndexServiceImpl.java | 31 +++++++++++++++++-- .../java/com/eden/orchid/impl/ImplModule.java | 2 ++ .../impl/themes/functions/LinkFunction.java | 3 +- .../orchid/impl/relations/PageRelation.kt | 7 ++++- OrchidCore/src/orchid/resources/config.yml | 2 +- .../src/orchid/resources/config/wiki.yml | 3 +- .../templates/_wikiBase_contentTypes.peb | 6 ++-- .../templates/components/homepage-grid.peb | 4 +-- .../components/homepage-open-source.peb | 4 +-- .../templates/pages/staticPage-bundles.peb | 2 +- .../wiki/user-manual/content/static-pages.md | 2 +- .../user-manual/content/writing-content.md | 2 +- .../resources/wiki/user-manual/quickstart.md | 1 - 14 files changed, 53 insertions(+), 18 deletions(-) diff --git a/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexService.java b/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexService.java index 80904af6ef..6848a502a2 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexService.java +++ b/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexService.java @@ -14,7 +14,7 @@ @ImplementedBy(IndexServiceImpl.class) public interface IndexService extends OrchidService { - String[] locateParams = new String[] {"itemId", "collectionId", "collectionType"}; + String[] locateParams = new String[] {"itemId", "collectionType", "collectionId"}; default void clearIndex() { getService(IndexService.class).clearIndex(); diff --git a/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexServiceImpl.java b/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexServiceImpl.java index 04a690c5dc..193da03d3f 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexServiceImpl.java +++ b/OrchidCore/src/main/java/com/eden/orchid/api/indexing/IndexServiceImpl.java @@ -1,11 +1,17 @@ package com.eden.orchid.api.indexing; import com.eden.common.util.EdenUtils; +import com.eden.orchid.Orchid; import com.eden.orchid.api.OrchidContext; +import com.eden.orchid.api.events.On; +import com.eden.orchid.api.events.OrchidEventListener; import com.eden.orchid.api.generators.GlobalCollection; import com.eden.orchid.api.generators.OrchidCollection; import com.eden.orchid.api.options.annotations.Description; import com.eden.orchid.api.theme.pages.OrchidPage; +import com.eden.orchid.utilities.CacheKt; +import com.eden.orchid.utilities.LRUCache; +import lombok.Data; import lombok.Getter; import javax.inject.Inject; @@ -25,7 +31,7 @@ */ @Singleton @Description(value = "How Orchid organizes the data it collects.", name = "Index") -public final class IndexServiceImpl implements IndexService { +public final class IndexServiceImpl implements IndexService, OrchidEventListener { private final Set globalCollections; @@ -35,9 +41,12 @@ public final class IndexServiceImpl implements IndexService { @Getter private List collections; + private final LRUCache collectionSearchCache; + @Inject public IndexServiceImpl(Set globalCollections) { this.globalCollections = Collections.unmodifiableSet(globalCollections); + this.collectionSearchCache = new LRUCache<>(); } @Override @@ -70,7 +79,10 @@ public void addCollections(List collections) { @Override public Object find(String collectionType, String collectionId, String itemId) { - return filterCollections(getCollections(collectionType, collectionId), itemId).findFirst().orElse(null); + final CollectionSearchCacheKey key = new CollectionSearchCacheKey(collectionType, collectionId, itemId); + return CacheKt.computeIfAbsent(collectionSearchCache, key, () -> { + return filterCollections(getCollections(collectionType, collectionId), itemId).findFirst().orElse(null); + }); } @Override @@ -129,4 +141,19 @@ private Stream optionallyFilterCollections(Stream } } +// Cache Implementation +//---------------------------------------------------------------------------------------------------------------------- + + @Data + public static class CollectionSearchCacheKey { + private final String collectionType; + private final String collectionId; + private final String itemId; + } + + @On(Orchid.Lifecycle.ClearCache.class) + public void onClearCache(Orchid.Lifecycle.ClearCache event) { + collectionSearchCache.clear(); + } + } diff --git a/OrchidCore/src/main/java/com/eden/orchid/impl/ImplModule.java b/OrchidCore/src/main/java/com/eden/orchid/impl/ImplModule.java index 9bb1802af4..6dc5bbd974 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/impl/ImplModule.java +++ b/OrchidCore/src/main/java/com/eden/orchid/impl/ImplModule.java @@ -10,6 +10,7 @@ import com.eden.orchid.api.events.OrchidEventListener; import com.eden.orchid.api.generators.GlobalCollection; import com.eden.orchid.api.generators.OrchidGenerator; +import com.eden.orchid.api.indexing.IndexServiceImpl; import com.eden.orchid.api.publication.OrchidPublisher; import com.eden.orchid.api.registration.IgnoreModule; import com.eden.orchid.api.registration.OrchidModule; @@ -188,6 +189,7 @@ protected void configure() { addToSet(OrchidEventListener.class, TaskServiceImpl.class, ResourceServiceImpl.class, + IndexServiceImpl.class, ClogSetupListener.class); addToSet(OrchidController.class); diff --git a/OrchidCore/src/main/java/com/eden/orchid/impl/themes/functions/LinkFunction.java b/OrchidCore/src/main/java/com/eden/orchid/impl/themes/functions/LinkFunction.java index eeb9a04c6d..977bb61a1a 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/impl/themes/functions/LinkFunction.java +++ b/OrchidCore/src/main/java/com/eden/orchid/impl/themes/functions/LinkFunction.java @@ -2,6 +2,7 @@ import com.eden.orchid.api.OrchidContext; import com.eden.orchid.api.compilers.TemplateFunction; +import com.eden.orchid.api.indexing.IndexService; import com.eden.orchid.api.options.annotations.Description; import com.eden.orchid.api.options.annotations.Option; import com.eden.orchid.api.theme.pages.OrchidPage; @@ -36,7 +37,7 @@ public LinkFunction(OrchidContext context) { @Override public String[] parameters() { - return new String[] {"itemId", "collectionId", "collectionType"}; + return IndexService.locateParams; } @Override diff --git a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/relations/PageRelation.kt b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/relations/PageRelation.kt index 7849fe0978..19946423c8 100644 --- a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/relations/PageRelation.kt +++ b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/relations/PageRelation.kt @@ -27,7 +27,12 @@ constructor( lateinit var collectionId: String override fun load(): OrchidPage? { - return context.findPage(this.collectionType, this.collectionId, this.itemId) + if(listOf(collectionType, collectionId, itemId).any { it.isNotBlank() }) { + return context.findPage(this.collectionType, this.collectionId, this.itemId) + } + else { + return null + } } } diff --git a/OrchidCore/src/orchid/resources/config.yml b/OrchidCore/src/orchid/resources/config.yml index 6faecda356..e6d9b03b68 100644 --- a/OrchidCore/src/orchid/resources/config.yml +++ b/OrchidCore/src/orchid/resources/config.yml @@ -44,7 +44,7 @@ services: disabled: - 'javadoc' - 'swiftdoc' - - 'kotlindoc' +# - 'kotlindoc' externalIndices: - 'https://javaeden.github.io/Clog/meta/javadoc.index.json' - 'https://javaeden.github.io/Common/meta/javadoc.index.json' diff --git a/OrchidCore/src/orchid/resources/config/wiki.yml b/OrchidCore/src/orchid/resources/config/wiki.yml index 93dfb4950c..4a784d4819 100644 --- a/OrchidCore/src/orchid/resources/config/wiki.yml +++ b/OrchidCore/src/orchid/resources/config/wiki.yml @@ -1,4 +1,5 @@ -includeIndexInPageTitle: false +defaultConfig: + includeIndexInPageTitle: false sections: - key: 'user-manual' title: 'User Manual' diff --git a/OrchidCore/src/orchid/resources/templates/_wikiBase_contentTypes.peb b/OrchidCore/src/orchid/resources/templates/_wikiBase_contentTypes.peb index b7f8d1aa4c..9126b81a48 100644 --- a/OrchidCore/src/orchid/resources/templates/_wikiBase_contentTypes.peb +++ b/OrchidCore/src/orchid/resources/templates/_wikiBase_contentTypes.peb @@ -3,12 +3,12 @@ {% block sectionIntro %} {% block pluginNotice %} {% alert 'info' :: compileAs('md') %} -The [{{ pluginName }}]({{ link(pluginName, 'staticPages-plugins') }}) plugin must be installed in order to use +The {{ anchor(pluginName, pluginName, 'pages', 'plugins') }} plugin must be installed in order to use {{ contentTypeTitle | pluralize }}. It can be included on its own, or added as part of the following bundles: {% for bundle in bundles %} -* [{{ bundle }}]({{ link(bundle, 'staticPages-bundles') }}) -{% endfor %} +* {{ anchor(bundle, bundle, 'pages', 'bundles') }} +{%- endfor %} {% endalert %} {% endblock %} diff --git a/OrchidCore/src/orchid/resources/templates/components/homepage-grid.peb b/OrchidCore/src/orchid/resources/templates/components/homepage-grid.peb index 7a12af0c0f..d33116667a 100644 --- a/OrchidCore/src/orchid/resources/templates/components/homepage-grid.peb +++ b/OrchidCore/src/orchid/resources/templates/components/homepage-grid.peb @@ -22,8 +22,8 @@

Orchid's unique indexing and plugin system allows the most complex ideas to be expressed in a way that works well with the entire ecosystem. Chose from one of the many plugins in - {{ anchor(title="our catalog", itemId='plugins', collectionType="taxonomy", collectionId="group") }} or - {{ anchor("make your own", "Developers Guide") }}. + {{ anchor('our catalog', 'plugins', 'taxonomy', 'group') }} or + {{ anchor('make your own', 'Developers Guide') }}.

diff --git a/OrchidCore/src/orchid/resources/templates/components/homepage-open-source.peb b/OrchidCore/src/orchid/resources/templates/components/homepage-open-source.peb index f2600ddfaa..36bc225a3b 100644 --- a/OrchidCore/src/orchid/resources/templates/components/homepage-open-source.peb +++ b/OrchidCore/src/orchid/resources/templates/components/homepage-open-source.peb @@ -4,8 +4,8 @@
Orchid is complete free and open-source, and always will be. Pick from one of our many great - {{ anchor(title="themes", itemId='themes', collectionType="taxonomy", collectionId="group") }} or - {{ anchor(title="plugins", itemId='plugins', collectionType="taxonomy", collectionId="group") }}, or create + {{ anchor('themes', 'themes', 'taxonomy', 'group') }} or + {{ anchor('plugins', 'plugins', 'taxonomy', 'group') }}, or create your own. Plugins are {{ anchor("really easy to make", "Developers Guide") }}, even if you want to keep them diff --git a/OrchidCore/src/orchid/resources/templates/pages/staticPage-bundles.peb b/OrchidCore/src/orchid/resources/templates/pages/staticPage-bundles.peb index 49df54d574..58d6c85d49 100644 --- a/OrchidCore/src/orchid/resources/templates/pages/staticPage-bundles.peb +++ b/OrchidCore/src/orchid/resources/templates/pages/staticPage-bundles.peb @@ -17,7 +17,7 @@
{% for pluginItem in included %} - {% set 'pageUrl' = link(pluginItem.pluginName, 'staticPages-'~plugin.pluginType) %} + {% set 'pageUrl' = link(pluginItem.pluginName, 'pages', pluginItem.pluginType) %} {% if pageUrl is not empty %} {{ pluginItem.pluginName }} diff --git a/OrchidCore/src/orchid/resources/wiki/user-manual/content/static-pages.md b/OrchidCore/src/orchid/resources/wiki/user-manual/content/static-pages.md index 01dbe34332..a403a42c04 100644 --- a/OrchidCore/src/orchid/resources/wiki/user-manual/content/static-pages.md +++ b/OrchidCore/src/orchid/resources/wiki/user-manual/content/static-pages.md @@ -1,5 +1,5 @@ --- -pluginName: OrchidPages +pluginName: Orchid Pages contentTypeTitle: static page bundles: - Orchid Blog diff --git a/OrchidCore/src/orchid/resources/wiki/user-manual/content/writing-content.md b/OrchidCore/src/orchid/resources/wiki/user-manual/content/writing-content.md index ecff01f9b0..d242fd3910 100644 --- a/OrchidCore/src/orchid/resources/wiki/user-manual/content/writing-content.md +++ b/OrchidCore/src/orchid/resources/wiki/user-manual/content/writing-content.md @@ -15,7 +15,7 @@ Page content in Orchid usually consists of two major sections: Front Matter, and ## Front Matter -The full details of a page's Front Matter are discussed in the [Page Content]({{ link('Page Configuration', 'wiki') }}) +The full details of a page's Front Matter are discussed in the {{ anchor('Page Content', 'Page Configuration', 'wiki') }} page, but in essence, Front Matter is a block of YAML between triple-dashed lines at the top of the file. The Front Matter can provide a lot of useful information to Orchid, such as: diff --git a/OrchidCore/src/orchid/resources/wiki/user-manual/quickstart.md b/OrchidCore/src/orchid/resources/wiki/user-manual/quickstart.md index cc22fff4fb..4f08bf4259 100644 --- a/OrchidCore/src/orchid/resources/wiki/user-manual/quickstart.md +++ b/OrchidCore/src/orchid/resources/wiki/user-manual/quickstart.md @@ -42,7 +42,6 @@ Add the [Orchid Gradle Plugin](https://plugins.gradle.org/plugin/com.eden.orchid The plugin adds several new tasks to run Orchid in various modes, along with replacing the Javadoc task with Orchid. It also opens up a configuration block where you can set options such as the theme and input/output directories of Orchid. -The plugin is explained in more detail in the {{anchor('Advanced Configuration')}} section. **Step 2** From 09657f7dbc6d458fda887486eb5defd20bfc85bc Mon Sep 17 00:00:00 2001 From: Casey Brooks Date: Mon, 1 Oct 2018 17:00:31 -0500 Subject: [PATCH 3/4] Adds changelog publisher to require a changelog entry for publishing. Updates deploy task to return failure exit code when deployment fails --- .../src/main/java/com/eden/orchid/Orchid.java | 19 +++++++++-- .../eden/orchid/api/tasks/TaskService.java | 4 +-- .../orchid/api/tasks/TaskServiceImpl.java | 12 +++---- .../orchid/impl/commands/DeployCommand.kt | 4 +-- .../com/eden/orchid/impl/tasks/DeployTask.kt | 8 +++-- OrchidCore/src/orchid/resources/config.yml | 3 ++ .../eden/orchid/changelog/ChangelogModule.kt | 4 +++ .../orchid/changelog/model/ChangelogModel.kt | 4 +++ .../RequiredChangelogVersionPublisher.kt | 33 +++++++++++++++++++ .../assets/js/server/vc_notification.js | 20 ++++++++--- 10 files changed, 89 insertions(+), 22 deletions(-) create mode 100644 plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/publication/RequiredChangelogVersionPublisher.kt diff --git a/OrchidCore/src/main/java/com/eden/orchid/Orchid.java b/OrchidCore/src/main/java/com/eden/orchid/Orchid.java index 2563b2415b..3c711a2d68 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/Orchid.java +++ b/OrchidCore/src/main/java/com/eden/orchid/Orchid.java @@ -107,7 +107,7 @@ public boolean start(List modules) { return true; } catch (Exception e) { - Clog.e("Something went wrong running Orchid: {}", e, e.getMessage()); + Clog.e("Something went wrong running Orchid", e); e.printStackTrace(); context.broadcast(Orchid.Lifecycle.Shutdown.fire(this)); @@ -292,9 +292,22 @@ public static class DeployStart extends OrchidEvent { * A deployment phase has completed, and we are now at the end of the {@link Orchid.State#DEPLOYING } state. */ public static class DeployFinish extends OrchidEvent { - private DeployFinish(Object sender) { super(sender); } + private final boolean success; + private DeployFinish(Object sender, boolean success) { + super(sender); + this.success = success; + } + + @Override + public String toString() { + JSONObject data = new JSONObject(); + + data.put("success", success); + + return data.toString(); + } - public static DeployFinish fire(Object sender) { return new DeployFinish(sender); } + public static DeployFinish fire(Object sender, boolean success) { return new DeployFinish(sender, success); } } /** diff --git a/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskService.java b/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskService.java index df2d985979..cfed043392 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskService.java +++ b/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskService.java @@ -38,8 +38,8 @@ default void serve() { getService(TaskService.class).serve(); } - default void deploy(boolean dryDeploy) { - getService(TaskService.class).deploy(dryDeploy); + default boolean deploy(boolean dryDeploy) { + return getService(TaskService.class).deploy(dryDeploy); } default TaskType getTaskType() { diff --git a/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskServiceImpl.java b/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskServiceImpl.java index 8e55ced9cc..baba9bb754 100644 --- a/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskServiceImpl.java +++ b/OrchidCore/src/main/java/com/eden/orchid/api/tasks/TaskServiceImpl.java @@ -214,22 +214,18 @@ public void serve() { } @Override - public void deploy(boolean dryDeploy) { + public boolean deploy(boolean dryDeploy) { initOptions(); Orchid.getInstance().setState(Orchid.State.DEPLOYING); Clog.i("Deploy Starting..."); context.broadcast(Orchid.Lifecycle.DeployStart.fire(this)); boolean success = context.publishAll(dryDeploy); - context.broadcast(Orchid.Lifecycle.DeployFinish.fire(this)); + context.broadcast(Orchid.Lifecycle.DeployFinish.fire(this, success)); + Clog.i("Deploy complete"); Orchid.getInstance().setState(Orchid.State.IDLE); - if(success) { - Clog.i("Deployment completed successfully"); - } - else { - Clog.w("Deployment failed"); - } + return success; } // Build Events diff --git a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/commands/DeployCommand.kt b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/commands/DeployCommand.kt index e6208aa565..fdee35692a 100644 --- a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/commands/DeployCommand.kt +++ b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/commands/DeployCommand.kt @@ -18,7 +18,7 @@ constructor( @Option @BooleanDefault(true) @Description("Whether to run a dry deploy, validating all options but not actually deploying anything.") - var isDry: Boolean = false + var dry: Boolean = true override fun parameters(): Array { return arrayOf("dry") @@ -26,7 +26,7 @@ constructor( @Throws(Exception::class) override fun run(commandName: String) { - contextProvider.get().deploy(isDry) + contextProvider.get().deploy(dry) } } diff --git a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/tasks/DeployTask.kt b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/tasks/DeployTask.kt index e030738987..4a7049fe31 100644 --- a/OrchidCore/src/main/kotlin/com/eden/orchid/impl/tasks/DeployTask.kt +++ b/OrchidCore/src/main/kotlin/com/eden/orchid/impl/tasks/DeployTask.kt @@ -14,12 +14,16 @@ class DeployTask @Inject constructor( private val contextProvider: Provider, - @param:Named("dryDeploy") private val dryDeploy: Boolean + @Named("dryDeploy") private val dryDeploy: Boolean ) : OrchidTask(100, "deploy", TaskService.TaskType.DEPLOY) { override fun run() { contextProvider.get().build() - contextProvider.get().deploy(dryDeploy) + val success = contextProvider.get().deploy(dryDeploy) + + if(!success) { + throw Exception("deployment failed, check logs for details") + } } } diff --git a/OrchidCore/src/orchid/resources/config.yml b/OrchidCore/src/orchid/resources/config.yml index e6d9b03b68..9e08e41f1c 100644 --- a/OrchidCore/src/orchid/resources/config.yml +++ b/OrchidCore/src/orchid/resources/config.yml @@ -49,3 +49,6 @@ services: - 'https://javaeden.github.io/Clog/meta/javadoc.index.json' - 'https://javaeden.github.io/Common/meta/javadoc.index.json' - 'https://copper-leaf.github.io/krow/meta/kotlindoc.index.json' + publications: + stages: + - type: requireChangelogVersion \ No newline at end of file diff --git a/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/ChangelogModule.kt b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/ChangelogModule.kt index e31b3b1dce..adf743a4ee 100644 --- a/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/ChangelogModule.kt +++ b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/ChangelogModule.kt @@ -1,10 +1,12 @@ package com.eden.orchid.changelog import com.eden.orchid.api.generators.OrchidGenerator +import com.eden.orchid.api.publication.OrchidPublisher import com.eden.orchid.api.registration.OrchidModule import com.eden.orchid.api.theme.components.OrchidComponent import com.eden.orchid.changelog.components.ChangelogComponent import com.eden.orchid.changelog.components.ChangelogVersionPicker +import com.eden.orchid.changelog.publication.RequiredChangelogVersionPublisher import com.eden.orchid.utilities.addToSet class ChangelogModule : OrchidModule() { @@ -13,9 +15,11 @@ class ChangelogModule : OrchidModule() { withResources(20) addToSet() + addToSet() addToSet( ChangelogComponent::class, ChangelogVersionPicker::class) } + } diff --git a/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/model/ChangelogModel.kt b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/model/ChangelogModel.kt index 22cfef2164..60fd9ca016 100644 --- a/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/model/ChangelogModel.kt +++ b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/model/ChangelogModel.kt @@ -11,5 +11,9 @@ class ChangelogModel { this.versions = versions } + fun getVersion(versionName: String): ChangelogVersion? { + return versions.find { it.version == versionName } + } + } diff --git a/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/publication/RequiredChangelogVersionPublisher.kt b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/publication/RequiredChangelogVersionPublisher.kt new file mode 100644 index 0000000000..12421e327d --- /dev/null +++ b/plugins/OrchidChangelog/src/main/kotlin/com/eden/orchid/changelog/publication/RequiredChangelogVersionPublisher.kt @@ -0,0 +1,33 @@ +package com.eden.orchid.changelog.publication + +import com.caseyjbrooks.clog.Clog +import com.eden.orchid.api.OrchidContext +import com.eden.orchid.api.publication.OrchidPublisher +import com.eden.orchid.changelog.model.ChangelogModel + +import javax.inject.Inject + +class RequiredChangelogVersionPublisher +@Inject +constructor( + context: OrchidContext, + val model: ChangelogModel +) : OrchidPublisher(context, "requireChangelogVersion", 100) { + + override fun validate(): Boolean { + var valid = super.validate() + + // make sure the current site version has a matching changelog version + if(model.getVersion(context.site.version) == null) { + Clog.e("Required changelog entry for version '{}' is missing.", context.site.version) + valid = false + } + + return valid + } + + override fun publish() { + // do nothing, we just want to validate the pipeline + } + +} diff --git a/plugins/OrchidPluginDocs/src/main/resources/assets/js/server/vc_notification.js b/plugins/OrchidPluginDocs/src/main/resources/assets/js/server/vc_notification.js index fe220ee58c..d0c2972b67 100644 --- a/plugins/OrchidPluginDocs/src/main/resources/assets/js/server/vc_notification.js +++ b/plugins/OrchidPluginDocs/src/main/resources/assets/js/server/vc_notification.js @@ -13,11 +13,21 @@ Vue.component('notifications', { }); }); this.$bus.$on('deployfinish', message => { - UIkit.notification({ - message: 'Deploy complete.', - status: 'success', - pos: 'bottom-right', - }); + var params = JSON.parse(message); + if(params.success) { + UIkit.notification({ + message: 'Deploy complete.', + status: 'success', + pos: 'bottom-right', + }); + } + else { + UIkit.notification({ + message: 'Deploy failed.', + status: 'danger', + pos: 'bottom-right', + }); + } }); }, beforeDestroy() { From 5ec1bd739e1f3be85e5259a124a4b770df26197d Mon Sep 17 00:00:00 2001 From: Casey Brooks Date: Mon, 1 Oct 2018 21:03:12 -0500 Subject: [PATCH 4/4] Adds 0.12.6 release notes --- OrchidCore/src/orchid/resources/changelog/0_12_6.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 OrchidCore/src/orchid/resources/changelog/0_12_6.md diff --git a/OrchidCore/src/orchid/resources/changelog/0_12_6.md b/OrchidCore/src/orchid/resources/changelog/0_12_6.md new file mode 100644 index 0000000000..e595b50487 --- /dev/null +++ b/OrchidCore/src/orchid/resources/changelog/0_12_6.md @@ -0,0 +1,8 @@ +--- +version: '0.12.6' +--- + +- Changes standard ordering of collection search params to ['itemId', 'collectionType', 'collectionId'], which is more + natural to think about and better matches the order in which the params would be needed. +- Adds changelog publisher to require a changelog entry for publishing. +- Orchid now exits with a failure status code when the `deploy` task deployment fails for any reason. \ No newline at end of file