maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[15 min fix] Update Publishing from RSS guide with correct instructions (#13756)

Browse source 
* Update Publishing from RSS guide with correct instructions

* Use colons, not arrows

* Update app/views/pages/publishing_from_rss_guide.html.erb

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
This commit is contained in:
rhymes 2021-05-13 17:00:35 +02:00 • committed by GitHub
parent f7293c3544
commit 1901ac9573
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
app/views/pages/_publishing_from_rss_guide_text.html.erb
View file

@ -1,27 +0,0 @@
<div class="container article" id="editor-help-guide">
<div class="title help-guide-title">
<h1>Publishing from RSS Guide</h1>
</div>
<div class="body">
<h2>Front Matter</h2>
<p>Our RSS reader converts some tags from the RSS items to tags for the Jekyll front matter:</p>
<ul>
<li><code>&lt;title&gt;</code>: <strong>title</strong></li>
<li><code>&lt;category&gt;</code>:
<strong>tags</strong>, comma separated. Since only 4 tags can be used in a post on <%= community_name %>, only the first four tags will be used from the RSS item.
</li>
<li><code>&lt;link&gt;</code>:
<strong>canonical_url</strong><br />Only if the "Mark the RSS source as canonical URL by default" option is enabled in the Publishing from RSS settings.
</li>
</ul>
<h2>Article Content</h2>
<p>The article content is prioritized in this order: <code>&lt;content&gt;</code>,
<code>&lt;summary&gt;</code>, or
<code>&lt;description&gt;</code>. The HTML will be converted to Markdown as the body of the <%= community_name %> post.</p>
<p>If you're using a Medium RSS feed, Tweet links, YouTube, and Gist iframes are converted to Liquid tags.</p>
<br />
<br />
<div class="blank-space"></div>
</div>
</div>

48
app/views/pages/publishing_from_rss_guide.html.erb
View file

@ -1,12 +1,46 @@
<% title "Editor Guide" %>
<% title "Editor Guide - Publishing from RSS or Atom" %>
<%= content_for :page_meta do %>
<link rel="canonical" href="<%= app_url("/p/publishing_from_rss_guide") %>" />
<meta name="description" content="dev.to | publishing from rss guideline">
<link rel="canonical" href="<%= app_url(publishing_from_rss_guide_path) %>" />
<meta name="description" content="<%= community_name %> | Publishing from RSS or Atom guidelines">
<%= meta_keywords_default %>
<% end %>
<header>
<div class="blank-space"></div>
</header>
<%= render "publishing_from_rss_guide_text" %>
<main class="container article" id="main-content">
<div class="title help-guide-title">
<h1>Publishing from RSS or Atom</h1>
</div>
<div class="body">
<h2>Front Matter</h2>
<p>Our feed reader converts some elements from the RSS or Atom feeds to tags for the editor's front matter:</p>
<ul>
<li>
<code>&lt;title&gt;</code>: <strong>title</strong>, the title of the post
</li>
<li>
<code>&lt;category&gt;</code>: <strong>tags</strong>, only the first four <code>&lt;category&gt;</code> elements
can be used in a post on <%= community_name %> per each item in the feed.
</li>
<li>
<code>&lt;link&gt;</code>: <strong>canonical_url</strong>, only used if the "Mark the RSS source as canonical URL by default"
option is enabled in the <%= link_to "RSS Settings", user_settings_path(:extensions) %>.
</li>
</ul>
<h2>Post Content</h2>
<p>
The post content is prioritized in this order: <code>&lt;content&gt;</code>, <code>&lt;summary&gt;</code>, or
<code>&lt;description&gt;</code>.
</p>
<p>The HTML will be converted to Markdown as the body of the <%= community_name %> post.</p>
<p>If you're using Medium RSS feed all its tweet links, YouTube, and Gist iframes will be converted to Liquid tags.</p>
<div class="blank-space"></div>
</div>
</main>

2
app/views/users/_publishing_from_rss.html.erb
View file

@ -20,7 +20,7 @@
<p>Formatting will typically look good, but you may have to make manual fixes. In the case of Medium, you may have to manually fix embeds.</p>
<p>
To find out more about how drafts are created from your feed, read this
<a href="/p/publishing_from_rss_guide">guide</a>.
<a href="<%= publishing_from_rss_guide_path %>">guide</a>.
</p>
<p>
Your feed will be fetched every time you submit this form and updates will be automatically fetched periodically thereafter. Contact