Welcome!

Open Source Cloud Authors: Pat Romanski, Elizabeth White, Liz McMillan, Rostyslav Demush, Charles Araujo

Blog Feed Post

The New Codeship Documentation

Codeship Documentation Header

How to handle increasing support requests

Over the last couple of months Codeship grew tremendously. We run more builds and deployments for a growing number of companies. We are always striving to make the setup on the Codeship a success for everyone, so thoroughly answering all support requests is really important for us. With the aforementioned growth our time invested into support increased a lot.

On the one hand we want to provide easy accessible information through our documentation and in app help and on the other hand it lets us focus more on specific support requests and on improving the product.

Automated messages for common errors

One important improvement was our recent automated error messages feature. We often see typical error messages in the log and in our support requests. For these error messages we show you a support message. This helps all of our users get a quick feedback and therefore doesn’t require additional support from us.

For example in the following image you can see an error message that a ruby gem was potentially removed from rubygems. This immediately tells you what the problem is.

Common Errors – Automated Message

We’ve added several auto-detections of common error messages and will be adding more in the future.

But this was only a first step. We needed to overhaul our docs. Not just to bring in more and better documentation, but also to have a better workflow in place to build on them.

Navigating through the Documentation

Codeship Documentation Overview Page

On the left side you can see all the different support categories.

You can use the tags we add to every article to jump to other relevant articles or search through the documentation on the top search bar.

You can get an overview on all the languages, databases or other technologies we support. Of course we added some information on our setup, general system, frequently asked questions and specific deployment guides.

We implemented our docs as static pages with Middleman and host them on Amazon S3. We will publish a blog post soon that will go into the details of the technology and workflow for our docs.

Our docs are open source on our Github repository. Let us know if you think we can improve our documentation, find errors in them or have general tips. We’re always eager for feedback and of course also for pull requests.

Have a look at our new documentation here.

Conclusions

After focusing on our product and technology for a while we are now putting a lot more of our time into usability and general ease of use. Great support and an easy and quick way to get the information you truly need are an important part of this. Now that we have the technology in place to move quickly with our docs we will put a lot of time into this, so Codeship becomes even easier to use and simpler to understand. The new documentation will help you get the relevant information you need as quickly as possible.

Ship long and prosper!

Read the original blog entry...

More Stories By Manuel Weiss

I am the cofounder of Codeship – a hosted Continuous Integration and Deployment platform for web applications. On the Codeship blog we love to write about Software Testing, Continuos Integration and Deployment. Also check out our weekly screencast series 'Testing Tuesday'!

IoT & Smart Cities Stories
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and Bi...
Nicolas Fierro is CEO of MIMIR Blockchain Solutions. He is a programmer, technologist, and operations dev who has worked with Ethereum and blockchain since 2014. His knowledge in blockchain dates to when he performed dev ops services to the Ethereum Foundation as one the privileged few developers to work with the original core team in Switzerland.
Contextual Analytics of various threat data provides a deeper understanding of a given threat and enables identification of unknown threat vectors. In his session at @ThingsExpo, David Dufour, Head of Security Architecture, IoT, Webroot, Inc., discussed how through the use of Big Data analytics and deep data correlation across different threat types, it is possible to gain a better understanding of where, how and to what level of danger a malicious actor poses to an organization, and to determin...
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
"MobiDev is a Ukraine-based software development company. We do mobile development, and we're specialists in that. But we do full stack software development for entrepreneurs, for emerging companies, and for enterprise ventures," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
Cloud computing delivers on-demand resources that provide businesses with flexibility and cost-savings. The challenge in moving workloads to the cloud has been the cost and complexity of ensuring the initial and ongoing security and regulatory (PCI, HIPAA, FFIEC) compliance across private and public clouds. Manual security compliance is slow, prone to human error, and represents over 50% of the cost of managing cloud applications. Determining how to automate cloud security compliance is critical...
Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...