Is this you? As a journalist, you can create a free Muck Rack account to customize your profile, list your contact preferences, and upload a portfolio of your best work.
Claim your profile
Articles by Anne Gentle
Yes You Can Use GitHub Pages with Python Sphinx
If you prefer to write in ReStructured Text instead of Markdown for your technical documentation, you’re in good company. There are quite a few benefits to using Sphinx, Python, RST, and Sphinx extensions because these tools are custom-built with developer documentation in mind. Another great offering is GitHub Pages, with automatic publishing when a known branch, such as the master or gh-pages branch is updated. So, how about the best of both?
Practical Advice On Publishing A Technical Book using GitHub and GitBook
What does it take to put together a web site, a book, an ebook, all for sale online? Let’s look at costs for tools and services that make it happen. Let’s look at what you need for a book idea. You need an audience, an editor, a way to reach that audience, and a “pitch” for the book idea itself. You may chose self-publishing over pitching the book idea to a technical book publisher.
Survey results for learning and teaching docs-like-code techniques
I asked three questions in a survey emailed to my mailing list and got more than 30 responses. Thanks to everyone who took the time to share their stories and respond. Here are the three questions: Question 1: When you talk to your leaders about docs-as-code, can they describe the benefits as well as the difficulties? Question 2: How do you onboard people who are new to your docs tools and processes?
What about wikis? Content management and change management
While I was writing Docs Like Code, I went back and forth in my mind, arguing with myself on whether the timing was quite right. I didn’t know for certain if we had reached a tipping point as an industry, or if I was simply seeing a trend relevant only to the open-source, developer-centric world I was embedded in. And then, I heard from Gene in an email. “Whenever I start considering retirement, again, I read one of your articles and get inspired to keep going.
Video Presentations about Docs Like Code
In the new year I want to keep learning more about docs like code, and I know that I’ve learned a lot from the Write the Docs community and presentations. Top of mind for me right now is that the 2018 conference in Portland Oregon is in May, 6-8 to be exact, and the call for proposals closes next Wednesday, January 10, 2018. You can register and buy your ticket - or tickets for your whole team - online now.
Explore API-first Sessions and Hands-on Workshops at Cisco Live
Seeing “Let’s Go!” in large letters, as the theme for Cisco Live US, reminds me of the soccer announcer’s “Gooooooooooaaaaaaaallllllllll” cry. This reminder excites me for the rest of Ted Lasso’s season 3. My mind makes these connections for football, er, soccer, and Cisco Live. Like the best examples of coaches are the ones with the best win/loss record, the same goes for Cisco APIs. And sometimes, the best coaches look for continuous improvement rather than winning at all costs.
API-first - Cisco Blogs
Sign up for API-first, API quality, and API security sessions at Cisco Live. From hands-on workshops to deep dives into best practices, you'll learn what Cisco has been up to in API design and implementation to improve your developer experience.
Silca Bar Tape - Guest Review (GRAVELBIKE.com)
I never thought of bar tape in terms other than thicker, plusher, fatter or maybe more or less likely to tear when I dump a bike and the handlebars–along with various body parts–get dragged through crushed rock. Since I never plan to crash, I honestly thought the point was to get tape as cushy as possible, and I certainly never encountered tape that performed differently based on the direction it’s wrapped. It goes without saying that I have very little experience tricking out my own bikes.
Bontrager Top Tube Bag
I Like Gas Tanks Or Do I? The Bontrager Adventure Top Tube Bag ($39.99 MSRP), or gas tank, is great. Is it great for every single person? Purt near! So thank you to GRAVELBIKE for facilitating this review, because I was very happy to check out another version of this type of bag. I was especially pleased to see that it sports reinforced openings and screws for securely attaching to your top tube, because my only complaint about gas tank bags (in general) is that they doesn’t stay in place.
Guest Review Archives - GRAVELBIKE
I never thought of bar tape in terms other than thicker, plusher, fatter or maybe more or less likely to tear when I dump a bike and the handlebars–along with various body parts–get dragged through crushed rock. Since I never plan to crash, I honestly thought the point was to get tape as cushy as possible, and I certainly never encountered tape that performed differently based on the direction it’s wrapped.
DevOps-friendly Docs Publishing for APIs
Here at Cisco, we have a developer program called DevNet that focuses on making Cisco APIs easier to use as well as work with developers and Cisco partners in many technology areas including IoT, Collaboration, and Software Defined Networking. The Cisco DevNet team loves working with developers, network administrators, and collaborators of all kinds. Mandy Whaley is the Director of Developer Experience for DevNet.
Continuous Integration for Docs, Code, Infrastructure, and the Network
Developer I haven’t been to a DeveloperWeek event yet even though one of them is in my home town of Austin Texas. I’m pretty excited to get to go to the Palmer Events Center next week and talk about continuous integration and continuous deployment (CI/CD) for developer documentation.
Second Look: Teravail Rampart Tires (Guest Review)
Summary: Slicks? For gravel? YES. I labored over my opening line because I was anxious to establish cred right away–that I’m an experienced, observant rider and gravel influencer… um, what? I’m totally not! I realized that, as a newer gravel rider and gear geek myself, I’d rather read a review from someone who was like me. And maybe others would, too. When my friends at GRAVELBIKE asked, “You have a Niner, right?
DevOps-friendly Docs Publishing for APIs
Here at Cisco, we have a developer program called DevNet that focuses on making Cisco APIs easier to use as well as work with developers and Cisco partners in many technology areas including IoT, Collaboration, and Software Defined Networking. The Cisco DevNet team loves working with developers, network administrators, and collaborators of all kinds. Mandy Whaley is the Director of Developer Experience for DevNet.
Always Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs
QCon London (March 27-29, 2023): Adopt the right emerging trends to solve your complex engineering challenges. Register Now. InfoQ Homepage Articles Always Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs Apr 25, 2017 9 min read Write for InfoQ Join a community of experts. Increase your visibility. Grow your career.Learn more Key Takeaways API documentation provides a critical path for predicting customer success.
What’s Happening at the OpenStack Summit in Barcelona?
The OpenStack Summit is a place to learn and collaborate, discuss and inspire, all in four days every six months. Keynote talks for the first day reflected the international blend of both the operators and users of OpenStack. Our Cisco team agreed that we like the overall message, which feels like, “Here is how we’ve changed the world,” rather than a call to change the world. Not that it felt like a done-deal, but that it provides a proud showcase of the feats of a world-wide cloud community.
Building resilient applications with Cisco Metacloud
This post walks through the models for building resilient applications on OpenStack infrastructure with Cisco Metacloud, OpenStack Orchestration, and configuration management tools like Ansible. In 2001, when a group of software developers discussed a growing trend of lightweight methods for producing software, they decided to group those together and write a new Agile Software Development Manifesto.
Technical Committee Highlights July 17, 2016
This update is dedicated to our recent in-person training for the Technical Committee and additional community leaders. Reflections on our Leadership Training Workshop In mid-July 2016, 20 members of the OpenStack community including Technical Committee members current and past, PTLs current and past, other Community members and additional supporting facilitators met for a 2 day training class at ZingTrain in Ann Arbor Michigan.
Technical Committee Highlights June 13, 2016
It has been a while since our last highlight post so this one is full of updates. New release tag: cycle-trailing This is a new addition to the set of tags describing the release models. This tag aims to allow specific projects for doing releases after the OpenStack release has been cut. This tag is useful for projects that need to wait for the “final” OpenStack release to be out. Some examples of these projects are Kolla, TripleO, Ansible, etc.
OpenStack works here… and now, I do, too!
OpenStack works here. I intend to make you think about a double meaning: OpenStack is both people and platform. We work here, and the platform works great here at Cisco. At the OpenStack Summit in Austin this week, I see a compelling need for OpenStack and the many private clouds springing to life. I want to build bridges to enable application workloads on OpenStack infrastructure, platforms, even when it requires microservices and containers.
Technical Committee Highlights March 21, 2016
Technical Committee Highlights March 21, 2016 Long time, no see! Poppy and our Open Core discussion The Poppy team applied to add the project under OpenStack governance. Poppy, for those of you not familiar with it, provides CDN as a service.
What’s next for application developer guides?
Summary This month, the developer.openstack.org site gets a new look and changes its source tooling. Read on for details about how these changes affect your project team. Why are we changing the developer.openstack.org site? You might know that the developer.openstack.org site documents over 900GET/PUT/POST/DELETE/PATCH calls for a dozen OpenStack services already on the developer.openstack.org site.
Technical Committee Highlights November 27, 2015
Technical Committee Highlights November 27, 2015 Welcome back from Tokyo. While there, I did not realize a three-dimensional subway map exists for Tokyo, but I sure loved traveling on the subway. Welcoming the latest projects to OpenStack Speaking of amazing cities and their subway maps, we should mention the growing list of OpenStack projects. We welcome these projects to OpenStack governance since the OpenStack Summit.
Technical Committee Highlights October 7, 2015
Technical Committee Highlights October 7, 2015 It’s a busy week pre-summit and pre-release so let’s jump into it. Technical Committee Elections this week There are 19 candidates for 6 positions in this six-month cycle of TC elections. Active Technical Contributors (ATCs) should have an email in their inbox to use to vote in this election. Sign into review.openstack.org and then go to Settings > Contact Information to find your Preferred Email, which is where the ballot was sent.
Technical Committee Highlights September 25, 2015
Tagging efforts for diversity and deprecation policies Since tagging projects for a percentage of diverse affiliations, we are also discussing the idea of an inverse tag to indicate non-diversity. Some of us on the TC are unsure that a lack of diversity is an indicator that the project isn’t useful or successful, especially in the early days of a project’s maturation. Others would like to indicate that a lack of diversity could mean support would be easy to pull.
Technical Committee Highlights September 2, 2015
Technical Committee Highlights September 2, 2015 New kids on the block There have been some new project team requests since the last post.
Technical Committee Highlights August 11, 2015
This week, the Technical Committee will not hold the regular Tuesday meeting. Here’s a round up of the discussions and decisions from the last week or so. Let us know how these posts are working for you by emailing, tweeting, commenting, or finding us on IRC. Midway focus points for the TC “Technical discussions are like lasagna.
Technical Committee Highlights July 24, 2015
Technical Committee Highlights July 24, 2015 Welcoming a common project for improving OpenStack user experience We accepted a proposal for a new UX Program whose mission is to support and facilitate cross-project efforts to improve the overall user experience of OpenStack. I personally find this as exciting an effort and innovative as cross-project documentation in open source.
CI/CD for documentation in OpenStack
How does OpenStack merge over 900 documentation changes in less than three months? We treat docs like code and continuously publish reviewed content from multiple git repositories. CI stands for continuous integration. Usually CI implies that the code is continually tested, integrated with other code changes, and then merged. Continuous deployment (CD) means the code is continously deployed with each patch to the entire code base.
Technical Committee Highlights July 10, 2015
We merged a couple of cross-project specifications after adequate discussion and time to review. We now are enabling Python 3 for application integration tests and have changed the requirements management design, please click through to specs.openstack.org and read the details on each. There’s a lot of discussion about a possible Stackforge retirement in order to alleviate the project github organization renaming work that happens when a project moves from the Stackforge org to the OpenStack org.
Technical Committee Highlights June 24, 2015
A compute starter kit tag has been approved, it provides a place for a beginner who only wants to try to get a computing cloud use case started. We discussed some reservations about recommending such a simple starting point, including only using nova-network for inter-vm networks, and recommending multi-host for that use case, but feel the current tagged projects indicate a decent starting point for now. We’ll update it as we see improvements to the starting experience.
Technical Committee Highlights June 5, 2015
Welcome to this week’s highlights from the Technical Committee. Just like every other week, this has been quite a busy one for the community and the efforts to enhance our governance model keep moving forward. The tc-approved-release tag was mentioned in the last edition of these highlights. The discussions has moved a step forward and the first, basic, version of this tag has been approved. You can read the full version here.
Technical Committee Highlights May 29, 2015
Welcome back from the summit. A huge part of OpenStack’s community gathered together in Vancouver for a week full of brainstorms, problem solving and planning for the next 6 months. So did the Technical Committee and here are the highlights of last week and this week’s meeting. We held a joint Board and TC meeting Sunday afternoon.
Technical Committee Highlights May 13, 2015
Based on multiple inputs from the openstack-dev mailing list, we’ve discovered we, the TC, need to level up our communications. We have identified two TC members to take on the communications plan, Anne Gentle (that’s me!) and Flavio Percoco. See below for details of the plan, and thanks for reading the first post in the revitalized series.
Big Data can drive big dollars. For any growing business, that’s the bottom line. As the amount of information in the world grows, your enterprise needs to start turning these bytes into bank. One way to do that is to move Big Data to the cloud.
Show More
loading
Actions
Is this you?
As a journalist, you can create a free Muck Rack account to customize your profile, list your contact preferences, and upload a portfolio of your best work.Get in touch with Anne
Contact Anne, search articles and posts on X, monitor coverage, and track replies from one place.
Learn more about Muck Rack