adding discourse forum page

Signed-off-by: Vanessa Sochat <[email protected]>

Author: vsoch

_config.yml

@@ -52,6 +52,14 @@ markdown: kramdown
 tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
 tag_color: danger # danger, success, warning, primary, info, secondary
 
+# Add a page at /forum to list a set of discourse topics. The site needs
+# to enable "embed topics" setting
+# https://meta.discourse.org/t/embedding-a-list-of-discourse-topics-in-another-site/125911
+discourse_site: "https://ask.cyberinfrastructure.org" 
+discourse_per_page: 10
+discourse_category: "stanford-research-computing"
+discourse_tags: null # comma separated string, leave null to not filter
+
 accentColor: red # purple, green, etc.
 themeColor: red # purple, green, blue, orange, purple, grey
 fixedNav: 'true' # true or false

_data/toc.yml

@@ -12,6 +12,8 @@
   children:
     - title: Quizzes
       url: "docs/extras/example-quiz"
+    - title: Discussion Forum
+      url: "forum"
 - title: "About"
   url: "about"
 - title: "News"

_docs/getting-started.md

@@ -36,8 +36,17 @@ excluded_in_search: true
 ---
 ```
 
-The example above is for a css file in the assets folder that is used as a template,
-but should not be included in search.
+The example above is for a css file in the assets folder that is used as a template, but should not be included in search. If you need to disable search entirely for a page, you can add the `disable_search` header:
+
+```
+---
+layout: null
+disable_search: true
+---
+```
+
+Disabling search will remove the search box at the top.
+
 
 ### External Search
 
@@ -47,6 +56,29 @@ For example, on an HPC site I'd want a tag like "mpi" to do a search on
 [http://ask.cyberinfrastructure.org](http://ask.cyberinfrastructure.org) for mpi.
 See the [tags](#tags) section below for how to configure this.
 
+
+### Discourse Forum
+
+If you have a discourse forum that you want to show questions from,
+there is an [easy way](https://meta.discourse.org/t/embedding-a-list-of-discourse-topics-in-another-site/125911) to embed them here. Specifically, there is an include `{% raw %}{% include embed/discourse.html %}{% endraw %}` that is deployed at [/forum]({{ site.baseurl }}/forum/) and added to the table of contents under Extra -> Discussion Forum. You can add this include to wherever you want the questions to appear. The follow parameters are defined in the config.yml:
+
+```yaml
+discourse_site: "https://ask.cyberinfrastructure.org" 
+discourse_per_page: 10
+discourse_category: "stanford-research-computing"
+discourse_tags: null # comma separated string, leave null to not filter
+```
+
+For the above, we embed 10 topics from the stanford-research-computing category of AskCI, and render 10 per page. Since there are few topics, we don't filter down to tags. If we did, we should provide a list of comma separated values.
+The page looks like this and is [live here]({{ site.baseurl }}/forum/):
+
+![{{ site.baseurl }}/assets/img/discourse-forum.png]({{ site.baseurl }}/assets/img/discourse-forum.png)
+
+Note that you aren't required to only embed one category - you can easily modify the code to include more than one by copy pasting the `d-topics-list`.
+
+{% include alert.html type="info" content="To use this for your discourse site, you must enable the 'embed topics' setting." %}
+
+
 ### Documentation
 
 Documentation pages should be written in the `docs` folder of the repository,

_includes/embed/discourse.html

@@ -0,0 +1,16 @@
+<style>
+iframe {
+  width: 100% !important;
+}
+</style>
+
+# Discussion Forum
+
+What questions are being asked on <a href="{{ site.discourse_site }}" target="_blank">{{ site.discourse_site }}</a>? The questions 
+below are from the <a href="{{ site.discourse_site }}/c/{{ site.discourse_category }}" target="_blank">{{ site.discourse_category }}</a> category.
+
+<hr>
+
+<script src="{{ site.discourse_site }}/javascripts/embed-topics.js"></script>
+
+<d-topics-list discourse-url="{{ site.discourse_site }}" category="{{ site.discourse_category }}" per-page="{{ site.discourse_per_page }}" {% if site.discourse_tags %}tags="{{ site.discouse_tags }}"{% endif %}></d-topics-list>

_includes/footer.html

@@ -43,5 +43,4 @@
 </footer>
 <script src="{{ site.baseurl }}/assets/js/application.js"></script>
 {% assign slashes = page.url | split: "/" %}
-<script>console.log('{{ slashes | size }}')</script>
 <script>app.initialize({version:"0.17.4", url:{base:'{{ site.baseurl }}'}})</script>

_includes/navigation.html

@@ -5,7 +5,7 @@
 </defs></svg>
 
     <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off>
-    <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off>
+{% if page.disable_search %}{% else %}<input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off>{% endif %}
     <label class=md-overlay data-md-component=overlay for=__drawer></label> <a href="#{{ page.title | slugify }}" tabindex=1 class=md-skip> Skip to content </a>
     <header class=md-header data-md-component=header>
         <nav class="md-header-nav md-grid">
@@ -24,7 +24,7 @@
                     </div>
                 </div>
                 <div class="md-flex__cell md-flex__cell--shrink">
-                    <label class="md-icon md-icon--search md-header-nav__button" for=__search></label>
+                    {% if page.disable_search %}{% else %}<label class="md-icon md-icon--search md-header-nav__button" for=__search></label>
                     <div class=md-search data-md-component=search role=dialog>
                         <label class=md-search__overlay for=__search></label>
                         <div class=md-search__inner role=search>
@@ -42,7 +42,7 @@
                                 </div>
                             </div>
                         </div>
-                    </div>
+                    </div>{% endif %}
                 </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         <div class="md-header-nav__source">

assets/img/discourse-forum.png

@@ -0,0 +1,6 @@
+---
+title: Discussion Forum
+permalink: /forum/
+---
+
+{% include embed/discourse.html %}