blueprints/doc/source/_templates/article_external.rst

3.6 KiB
Executable File

. meta::
description

add a SEO description here

keywords

add SEO keywords here, and list additionally all OTC services used

Article (External)

Introduction

> There are no further requirements for an article except to include the following sections at theend, and to follow all general Open Telekom Cloud Architecture Center content requirements.
> An Open Telekom Cloud Architecture Center article template, forexternal* creators, requires the following sections at the end of the article:*

TL;DR

>> Make a brief summary of what is the article about
> 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.
> You can name the Section titles as it seems fit to the workflow of the article.

Section 1

Section 2

Section n

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:

> 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 notprimary) authors, major editors (not minor edits), and technical reviewers.
> List them alphabetically, by last name. Use this format:Fname Lname.

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

Resources

> If there are additional deployable resources like Cloud Topology Designer solution or Github repos, list them first with the aformentioned order

References

> Add site-relative links to Architecture Center articles
> Add links to external or third-party resources
> REMOVE ALL THE LINES THAT START WITH "| >"