Publishing DCC-EX News Posts
What is DCC-EX News?
“DCC-EX News” is our new announcements/news feed, using the Sphinx extension ABlog.
Given our website is static HTML pages hosted on GitHub Pages, we are limited on available options to provide a feed based content delivery system, so utilising existing blog functionality is the only suitable option.
Posting new content
Posting new content is a simple matter of creating a reStructuredText formatted file in the “news/posts” directory of our website repository using the provided “post-template.txt” located in that same directory.
Providing the correct template format is maintained, there is no need to edit anything outside of the individual file being created, and the website should build correctly once a PR is submitted and merged with the Sphinx branch of the repository.
Local previews can still be generated as per Live previews.
Using the post-template.txt template
To create a new post, copy the file “post-template.txt” to a new .rst file, with the name in reverse date format <yyyymmdd>.rst eg. 20230308.rst for a post on the 8th of March, 2023.
This new file must reside in the “news/posts” directory along with the other posts.
The content of the file should start like this:
.. include:: /include/include.rst .. include:: /include/include-l2.rst :blogpost: true :date: <date in format day month, year eg. 8 March, 2023> :author: <Your name, either Discord/GitHub username or real name> :category: <Refer to the doco for the category> :tags: <Refer to the doco for tags to use (comma separated list)> :excerpt: 1 :image: 0 .. image:: /_static/images/logos/product-logo-news.png :alt: DCC-EX News :scale: 40% :class: image-product-logo-float-right Post title ========== A catchy one-liner here to get people's interest, and this will show on the front page and in RSS/Atom feeds. The rest of the content goes here. Feel free to use our product shortcuts such as |DCC-EX|, |EX-CS|, |EX-TT|, |EX-R|, |EX-IO|, |EX-DCCI|, |EX-FC|.
Update the title
Provide a brief title that brings the reader’s eye to the content.
Update the content
When updating the content, the first paragraph will appear as an excerpt on the front page of our website, so make it catchy to grab the reader’s attention, but don’t make it too long, as the goal is to encourage the reader to view the full post.
This paragraph will also appear in RSS/Atom feed readers as the preview.
When populating the rest of the content, you will be able to use all the product and other expansion names, logos, and so forth as we use throughout the website, and you can include images etc. just like any other documentation page.