Table of Contents
How to add articles and tutorials to Tips, Tricks and Code
1. Creating Tips, Tricks and Code page
2. Page content recommendations
3. Navigating in the Tips, Tricks and Code
How to add articles and tutorials to Tips, Tricks and Code
1. Make sure you are logged in to the Tech Community
2. Go to the Tips, Tricks and Code home page
3. Click on Add New button
4. Enter the content of the article or tutorial and hit Publish once you are ready
Please let us know if you face some issues or need assistance.
For basic instructions on using the Tips, Tricks and Code, please refer to the sections below:
Once you land in the section click on Add New and you will arrive at the interface to create an article.
You need to fill in the following details:
1.1 Title
Make sure the title is a meaningful one. We recommend you include the full name of the product or feature you are writing about.
1.2 Format
When writing articles in the Tech Community you use a WYSWYG editor to post content.
The page will be rendered using HTML.
1.3 HTML
It allows you to add flash or YouTube videos to your pages by embedding them in the HTML source.
You can check and edit the HTML code directly by clicking on the Source button.
1.4 Attachments
You can upload additional documents, images, code samples, and etc. You can do it either by drag and drop the files or by “Select Files” and uploading them to the article.
1.5 Tags
‘Tags’ field is mandatory if tags are missing you will not be able to save and publish your article. You can add as many tags as you wish. We strongly recommend you to Select Tags from the list with checkboxes.
Here are some of the benefits of adding the right tags:
- Your article will appear on the relevant product landing pages
- The content will appear under the right product category
1.6 Related Assets
While editing an article you will notice the feature Related assets below the tag list. With the help of it, readers can get an easy access to selected articles from the Blog or the Tips, Tricks and Code section (Wiki page).
2. Page content
A good wiki page consists of:
2.1 Introduction
The intro is a short summary of your article or tutorial. The introduction provides context and gives a brief overview of what the article includes. Few recommendations:
- Keep it brief - Introductions don't have to be long.
- Present the reason for the post's existence
- Include details on an applicable version - this will help to identify the relevance of the resource at a first glance
A good example of introduction:
|
This article will explain the configuration steps for API Gateway cluster and expected behaviors of API Gateway when different servers go down. Supported Version: 9.12 onwards |
From the article API Gateway cluster configurations and behaviors
2.2 Different content sections
When structuring your page make sure you use different heading styles so that the content can be digested easier.
2.3 Examples
Here are a few randomly selected and well-formatted wiki entries
- API Gateway cluster configurations and behaviors
- Securing APIs using JSON Web Token in API Gateway
- Register Dynamics CRM App with Azure for OAuth 2.0 Authentication
3.1 Top Navigation - Product Filter
By selecting a Product from the main Tech Community navigation you see articles filtered by this Product in the section Tips, Tricks and Code.
3.2 Search in the Tips, Tricks and Code
Type the term/product you are looking for in the search field and click the Read button. This will show you results of wiki pages based on this search term.
3.3 Recent Changes
You can see the articles and tutorials that have been changed recently.
3.4 Draft Pages
Here you can see your drafts.
3.5 Post Code on GitHub
If you'd like to share a piece of code with the community, this page will provide a brief how-to on using the Software AG projects residing in GitHub.
These basic steps will help you contribute to the Tech Community knowledge exchange and will help you navigate through the resources provided by other members. In the Advanced Tips, Tricks and Code Guide we'll walk you through even more features that will beautify your content and make your article look more appealing and easier to digest:
