Welcome!

Eclipse Authors: Pat Romanski, Elizabeth White, Liz McMillan, David H Deans, JP Morgenthal

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
Founded in 2000, Chetu Inc. is a global provider of customized software development solutions and IT staff augmentation services for software technology providers. By providing clients with unparalleled niche technology expertise and industry experience, Chetu has become the premiere long-term, back-end software development partner for start-ups, SMBs, and Fortune 500 companies. Chetu is headquartered in Plantation, Florida, with thirteen offices throughout the U.S. and abroad.
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
SYS-CON Events announced today that DatacenterDynamics has been named “Media Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY. DatacenterDynamics is a brand of DCD Group, a global B2B media and publishing company that develops products to help senior professionals in the world's most ICT dependent organizations make risk-based infrastructure and capacity decisions.
A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to great conferences, helping you discover new conferences and increase your return on investment.
DXWorldEXPO LLC announced today that ICOHOLDER named "Media Sponsor" of Miami Blockchain Event by FinTechEXPO. ICOHOLDER gives detailed information and help the community to invest in the trusty projects. Miami Blockchain Event by FinTechEXPO has opened its Call for Papers. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Miami Blockchain Event by FinTechEXPOalso offers sp...
Headquartered in Plainsboro, NJ, Synametrics Technologies has provided IT professionals and computer systems developers since 1997. Based on the success of their initial product offerings (WinSQL and DeltaCopy), the company continues to create and hone innovative products that help its customers get more from their computer applications, databases and infrastructure. To date, over one million users around the world have chosen Synametrics solutions to help power their accelerated business or per...
Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
@DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time t...
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...
SYS-CON Events announced today that IoT Global Network has been named “Media Sponsor” of SYS-CON's @ThingsExpo, which will take place on June 6–8, 2017, at the Javits Center in New York City, NY. The IoT Global Network is a platform where you can connect with industry experts and network across the IoT community to build the successful IoT business of the future.