A few months ago we launched our integrations section in the SOOMLA Knowledge Base. So far, we’ve received some significant code sample contributions from the likes of Supersonic, TUNE, GameAnalytics, Fyber, AdColony, Unity Ads and a few more. Since our knowledge base website is open sourced on Github, we’d like to offer more companies to submit their integration code samples. This blog post will describe how to set up such a dedicated, branded page for your platform / service.
- Fork the SOOMLA knowledge base to your Github account and then clone it locally.
- Get the knowledge base running locally by following the guidelines in the Github repo. Our knowledge base website uses Docpad, a Node.js based static website generator. Documents are written with Markdown for ease.
- Once you’ve got it running, switch to the
samplesbranch and restart the local server by running
Create Your Platform Page
- Integration pages are all located under
src/documents/samples. You will see that some samples have both a file and a folder with their name. That’s because they’ve separated their code samples into separate files which is the right way to go. Let’s use Fyber for example, you can observe the file on Github: https://github.com/soomla/knowledge-base/blob/samples/src/documents/samples/fyber.html.md.eco.
- Make a copy of
fyber.html.md.ecoin the same folder and replace “fyber” with your platform’s name.
- Create a sibling folder to the
fyberfolder with your platform’s name.
- Note that file name conventions are all lowercase here.
- Note that the file has the
.html.md.ecosuffix since it goes through Docpad’s pre-processing pipeline in reverse suffix order. The document is first parsed as an eco template (to allow partial inclusions), then as a Markdown file (for code formatting) and finally lands as an HTML file.
- Locate the page’s metadata at the top. An example metadata section looks like this:
--- layout: "sample" image: "supersonic_logo" title: "Supersonic" text: "Show rewarded video / offer wall to earn coins" position: 10 relates: ["giftgaming", "fyber", "unity_ads"] collection: 'samples' navicon: "nav-icon-supersonic.png" backlink: "http://www.supersonic.com/" theme: 'samples' ---
- Change these fields:
backlink. Specifically in the
textattribute, list the use case of using your platform with SOOMLA
A page’s content should include:
- A descriptive paragraph at the beginning explaining a bit about the platform. Why is it unique? How does it help developers? What is the relationship with SOOMLA’s open source SDK / data platform?
- Code samples divided to different technologies in different tabs. See other pages for the tab implementation. Make sure to place the code samples in the folder you created in the first steps and include it with code similar like this: <
%- @include('./fyber/fyber_example.cs') %>.
- A “Getting Started” section with several simple steps of how to get up and running quickly. Include links to downloads, sign up pages, resouces, tutorials etc.
- All code and explanations should be concise and focused on the use case. There is no need to create elaborate classes with tons of platform specific code. Keep only what’s necessary, and have a look at other samples to see how they do it.
Submitting The Page
- Submit a pull request on Github to the
samplesbranch on SOOMLA’s repo.
- Send us 2 key images with a transparent background to firstname.lastname@example.org:
- A small 100×100 icon – only the logo without labels
- A larger icon that shows both the company icon and label.
That’s it. If you need any further help you can also reach me personally at email@example.com. Happy Coding 🙂