architecture-center/doc/source/_templates/article_external.tpl
2024-02-05 08:21:36 +01:00

125 lines
3.6 KiB
Smarty
Executable File

. meta::
:description: add a SEO description here
:keywords: add SEO keywords here, and list additionally all OTC services used
==================
Article (External)
==================
.. Introduction
Introduction
============
| > *There are no further requirements for an article except to include the following sections at the **end**, and to follow all general Open Telekom Cloud Architecture Center content requirements.*
| > *An Open Telekom Cloud Architecture Center article template, for **external** creators, requires the following sections at the end of the article:*
.. topic:: TL;DR
| >> Make a brief summary of what is the article about
.. Main Article
.. Components
| > *No header required here*
| > *(Expected to list all the Open Telekom Cloud components used, but it could be optional if it just an architectural paradigm.*
.. Sections 1..n
| > You can name the Section titles as it seems fit to the workflow of the article.
Section 1
=========
Section 2
=========
Section n
=========
.. Authors and Contributors
Contributors
============
| > *(Expected, but it could be optional if all the contributors would prefer not to be mentioned)*
| > *Start with the explanation text (same for every article), in italics.*
| > *Then include the "Principal authors" list and the "Additional contributors" list (if there are additional contributors) (all in plain text, not italics or bold).*
| > *Link each contributor's name to the person's LinkedIn profile.*
| > *After the name, place a pipe symbol ("|") with spaces, and then enter the person's title.*
| > *Do not include any additional links except the LinkedIn profile URL.*
*It was originally written by the following contributors:*
Principal authors:
.. admonition:: Authors
`(Author 1 Name) | (Title, such as "Cloud Engineer") <http://linkedin.com/ProfileURL>`_
`(Author 2 Name) | (Title, such as "Cloud Architect") <http://linkedin.com/ProfileURL>`_
| > *Only the primary authors.*
| > *List them alphabetically, by last name.*
| > *Use this format: **Fname Lname**.*
| > *If the article gets rewritten, keep the original authors and add in the new one(s).*
Other contributors:
| > *Include contributing (but not **primary**) authors, major editors (not minor edits), and technical reviewers.*
| > *List them alphabetically, by last name. Use this format: **Fname Lname**.*
.. admonition:: Contributors
`(Author 1 Name) | (Title, such as "Cloud Engineer") <http://linkedin.com/ProfileURL>`_
`(Author 2 Name) | (Title, such as "Cloud Architect") <http://linkedin.com/ProfileURL>`_
.. Next steps & Related Resources
Next Steps
==========
| > *(Expected, but it could be optional if you don't want the article stops here and doesn't connect with other resources)*
| > *Add site-relative links to Architecture Center related articles but NOT to external or third-party resources*
| > *If there are additional resources like Cloud Topology Designer solution or Github repos, list them first with the aforementioned order*
.. seealso::
`Link1 <https://www.t-systems.com>`_
`Link2 <https://www.t-systems.com>`_
Resources
=========
.. Resources
| > *If there are additional deployable resources like Cloud Topology Designer solution or Github repos, list them first with the aforementioned order*
.. seealso::
`Link1 <https://www.t-systems.com>`_
`Link2 <https://www.t-systems.com>`_
.. References
References
==========
| > *Add site-relative links to Architecture Center articles*
| > *Add links to external or third-party resources*
.. seealso::
`Link1 <https://www.t-systems.com>`_
`Link2 <https://www.t-systems.com>`_
| > **REMOVE ALL THE LINES THAT START WITH "| >"**