<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Contributing to Radius on Radius Docs</title><link>https://docs.radapp.io/edge/contributing/</link><description>Recent content in Contributing to Radius on Radius Docs</description><generator>Hugo</generator><language>en-us</language><atom:link href="https://docs.radapp.io/edge/contributing/index.xml" rel="self" type="application/rss+xml"/><item><title>How-To: Contribute to the Radius documentation</title><link>https://docs.radapp.io/edge/contributing/contributing-docs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.radapp.io/edge/contributing/contributing-docs/</guid><description>&lt;p&gt;Radius uses the &lt;a href="https://diataxis.fr/" target="_blank" rel="noopener"&gt;Diátaxis framework&lt;/a&gt; for its documentation:&lt;/p&gt;&#10;&#10;&#10;&#10;&#10;&#10;&#10;&#10; &lt;img src="https://docs.radapp.io/edge/contributing/contributing-docs/diataxis.png" width="800px"&gt;&#10;&#10;&#10;&lt;p&gt;Follow the guidance on this page to learn how to get started, how to contribute, and how to use the Diátaxis framework to create new docs.&lt;/p&gt;&#10;&lt;h2 id="setup-your-docs-environment"&gt;Setup your docs environment&lt;/h2&gt;&#10;&lt;ul class="nav nav-tabs" id="tabs-1" role="tablist"&gt;&lt;li class="nav-item"&gt;&lt;a class="nav-link active"&#10; id="tabs-1-github-codespace-tab" data-bs-toggle="tab" data-tab-label="github-codespace" href="#tabs-1-github-codespace" role="tab"&#10; aria-controls="tabs-1-github-codespace" aria-selected="true"&gt;&#10; GitHub Codespace&#10; &lt;/a&gt;&#10; &lt;/li&gt;&lt;li class="nav-item"&gt;&lt;a class="nav-link"&#10; id="tabs-1-local-machine-tab" data-bs-toggle="tab" data-tab-label="local-machine" href="#tabs-1-local-machine" role="tab"&#10; aria-controls="tabs-1-local-machine" aria-selected="false"&gt;&#10; Local machine&#10; &lt;/a&gt;&#10; &lt;/li&gt;&lt;/ul&gt;&#10;&#10;&#10;&lt;div class="tab-content" id="tabs-1-content"&gt;&#10;&#10;&#10;&lt;div class="tab-pane fade show active" id="tabs-1-github-codespace" role="tabpanel" aria-labelled-by="tabs-1-github-codespace-tab"&gt;&#10;&lt;br /&gt;&lt;p&gt;The easiest way to get up and running is with a GitHub Codespace. This gives you a fully configured environment with all the tools you need to build the docs, all in your browser.&lt;/p&gt;&#10;&lt;p&gt;&lt;a class="btn btn-primary" href="https://github.com/codespaces/new?hide_repo_select=true&amp;amp;repo=421982809" role="button"&gt;Create codespace&lt;/a&gt;&lt;br /&gt;&#10;&lt;br /&gt;&lt;/p&gt;&#10;&lt;blockquote&gt;&#10;&lt;p&gt;Note the &lt;code&gt;postCreateCommand&lt;/code&gt; may take up to 3 minutes to complete after the codespace is created.&lt;/p&gt;&#10;&lt;/blockquote&gt;&#10;&lt;ol&gt;&#10;&lt;li&gt;Start Codespace&lt;/li&gt;&#10;&lt;li&gt;Wait for &lt;code&gt;postCreateCommand&lt;/code&gt; to complete&lt;/li&gt;&#10;&lt;li&gt;Run &lt;code&gt;npm start&lt;/code&gt; from the repository root to start the local server with the project&amp;rsquo;s Hugo and Dart Sass versions&lt;/li&gt;&#10;&lt;li&gt;Click on the link in the terminal to open the docs in your browser&lt;/li&gt;&#10;&lt;/ol&gt;&#10;&lt;/div&gt;&#10;&#10;&lt;div class="tab-pane fade" id="tabs-1-local-machine" role="tabpanel" aria-labelled-by="tabs-1-local-machine-tab"&gt;&#10;&lt;br /&gt;&lt;p&gt;&lt;strong&gt;Pre-requisites&lt;/strong&gt;&lt;/p&gt;&#10;&lt;ul&gt;&#10;&lt;li&gt;&lt;a href="https://nodejs.org/en/" target="_blank" rel="noopener"&gt;Node.js&lt;/a&gt;&lt;/li&gt;&#10;&lt;li&gt;&lt;a href="https://go.dev/dl/" target="_blank" rel="noopener"&gt;Go&lt;/a&gt; to load the Hugo theme and generate CLI docs&lt;/li&gt;&#10;&lt;li&gt;&lt;a href="https://git-scm.com/downloads" target="_blank" rel="noopener"&gt;git&lt;/a&gt;&lt;/li&gt;&#10;&lt;/ul&gt;&#10;&lt;p&gt;&lt;strong&gt;Environment setup&lt;/strong&gt;&lt;/p&gt;&#10;&lt;ol&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Ensure pre-requisites are installed&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Clone this repository and the radius repository&lt;/p&gt;&#10;&lt;div class="highlight"&gt;&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"&gt;&lt;code class="language-sh" data-lang="sh"&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;git clone https://github.com/radius-project/radius.git&#10;&lt;/span&gt;&lt;/span&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;git clone https://github.com/radius-project/docs.git&#10;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Generate CLI docs:&lt;/p&gt;&#10;&lt;div class="highlight"&gt;&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"&gt;&lt;code class="language-sh" data-lang="sh"&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;pushd radius&#10;&lt;/span&gt;&lt;/span&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;go run ./cmd/docgen/main.go ../docs/content/reference/cli&#10;&lt;/span&gt;&lt;/span&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;popd&#10;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Enter the cloned &lt;code&gt;radius-project/docs&lt;/code&gt; repository:&lt;/p&gt;&#10;&lt;div class="highlight"&gt;&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"&gt;&lt;code class="language-sh" data-lang="sh"&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;cd docs&#10;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Install npm packages:&lt;/p&gt;&#10;&lt;div class="highlight"&gt;&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"&gt;&lt;code class="language-sh" data-lang="sh"&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;npm ci&#10;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;blockquote&gt;&#10;&lt;p&gt;The &lt;a href="https://www.docsy.dev/" target="_blank" rel="noopener"&gt;Docsy theme&lt;/a&gt; is pulled in automatically as a &lt;a href="https://gohugo.io/hugo-modules/" target="_blank" rel="noopener"&gt;Hugo Module&lt;/a&gt;, so there is no separate theme initialization step.&lt;/p&gt;&#10;&lt;/blockquote&gt;&#10;&lt;/li&gt;&#10;&lt;/ol&gt;&#10;&lt;p&gt;&lt;strong&gt;Run local server&lt;/strong&gt;&lt;/p&gt;&#10;&lt;ol&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Make sure you&amp;rsquo;re still in the repository root&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Run&lt;/p&gt;&#10;&lt;div class="highlight"&gt;&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"&gt;&lt;code class="language-sh" data-lang="sh"&gt;&lt;span style="display:flex;"&gt;&lt;span&gt;npm start&#10;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;Open the URL printed by Hugo in the terminal&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;/ol&gt;&#10;&lt;/div&gt;&#10;&#10;&#10;&lt;/div&gt;</description></item><item><title>Spread the word</title><link>https://docs.radapp.io/edge/contributing/advocacy/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.radapp.io/edge/contributing/advocacy/</guid><description>&lt;p&gt;Help spread the word about Radius! Whether you&amp;rsquo;re giving a talk, writing a blog post, sharing on social media, or introducing Radius to your team, this page has the resources to help.&lt;/p&gt;&#10;&lt;h2 id="give-a-presentation"&gt;Give a presentation&lt;/h2&gt;&#10;&lt;p&gt;We welcome community members giving presentations on Radius and spreading the word about all its features.&lt;/p&gt;&#10;&lt;ol&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;&lt;strong&gt;Download the slide template.&lt;/strong&gt; Start from the template PowerPoint, which contains the slides you need to give a Radius presentation.&lt;/p&gt;&#10;&lt;p&gt;&lt;a class="btn btn-primary" href="https://github.com/radius-project/docs/raw/edge/presentation-pack/Radius.potx" role="button" target="_blank"&gt;Download the Radius PowerPoint template&lt;/a&gt;&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;&lt;strong&gt;Gather supporting assets.&lt;/strong&gt; Browse the &lt;a href="https://github.com/radius-project/docs/tree/edge/presentation-pack" target="_blank" rel="noopener"&gt;presentation pack directory&lt;/a&gt; for diagrams and images you can reuse.&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;&lt;strong&gt;Prepare your pitch.&lt;/strong&gt; Review the &lt;a href="https://docs.radapp.io/edge/concepts/"&gt;concepts&lt;/a&gt; so you can explain what Radius is and why it matters.&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;li&gt;&#10;&lt;p&gt;&lt;strong&gt;Prepare a demo.&lt;/strong&gt; Use the &lt;a href="https://docs.radapp.io/edge/getting-started/"&gt;getting started guide&lt;/a&gt; and the &lt;a href="https://github.com/radius-project/samples" target="_blank" rel="noopener"&gt;samples repository&lt;/a&gt; to demonstrate Radius in action.&lt;/p&gt;&#10;&lt;/li&gt;&#10;&lt;/ol&gt;</description></item></channel></rss>