When you treat docs like code, you multiply everyone’s efforts and streamline processes through collaboration, automation, and plain old hard work. To create a cohesive API experience, developers, technical marketing engineers, technical writers, and product managers can work together on GitHub to produce web pages and API documentation, including interactive API docs and tutorials. The ways you can leverage developer processes and tools in a docs-as-code system vary widely. Let's walk through some examples including tools, version control, publishing workflows, approvals, source formats, checklists, automated testing, and final approval. Also, let's take some time to share some of the pitfalls and difficulties possible when you work on API and tools documentation for a large and varied product catalog with more than a thousand contributors.
We present how Cisco Engineering uses the OpenAPI specifications to drive API quality and state-of-the-art developer experience. We then describe OpenAPI best practices, tools and processes built internally and opensource'd. Finally, we cover lessons learnt when standardizing on OAS for organizations with a massive API portfolio.
This talk was delivered at API Days Global/Paris on December 14th
Jfokus_Bringing the cloud back down to earth.pptxGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
FooConf23_Bringing the cloud back down to earth.pptxGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
apidays Paris 2022 - The 12 Facets of the OpenAPI Specification, Steve Sfartz...apidays
apidays Paris 2022 - APIs the next 10 years: Software, Society, Sovereignty, Sustainability
December 14, 15 & 16, 2022
The 12 Facets of the OpenAPI Specification
Steve Sfartz, Principal Architect at Cisco
------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
GitHub Gone Wrong - Lessons learned from organic open sourceAll Things Open
Presented by: Charles Eckel
Presented at the All Things Open 2021
Raleigh, NC, USA
Raleigh Convention Center
Abstract: Creating a GitHub organization with public repos is free, fast, and easy. This fosters a wild west of GitHub usage within corporations that is as confusing and troubling as it is liberating and empowering. We explore how GitHub has been used organically throughout Cisco and efforts to establish best practices that enable efficient open source collaboration that is responsible and sustainable.
Accelerating DevOps at the SF DevOps MeetUpjwi11iams
The Codenvy slide presentation given on September 28, 2015 at the SF DevOps MeetUp. This talk covered Codenvy's journey to continuous development and how Codenvy helps accelerate DevOps though increasing code commits and feedback iterations.
Docker Birthday #3 - Intro to Docker SlidesDocker, Inc.
High level overview of Docker + Birthday #3 overview (app and challenge portion)!
Learn more about Docker Birthday #3 celebrations here: https://www.docker.com/community/docker-birthday-3
We present how Cisco Engineering uses the OpenAPI specifications to drive API quality and state-of-the-art developer experience. We then describe OpenAPI best practices, tools and processes built internally and opensource'd. Finally, we cover lessons learnt when standardizing on OAS for organizations with a massive API portfolio.
This talk was delivered at API Days Global/Paris on December 14th
Jfokus_Bringing the cloud back down to earth.pptxGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
FooConf23_Bringing the cloud back down to earth.pptxGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
apidays Paris 2022 - The 12 Facets of the OpenAPI Specification, Steve Sfartz...apidays
apidays Paris 2022 - APIs the next 10 years: Software, Society, Sovereignty, Sustainability
December 14, 15 & 16, 2022
The 12 Facets of the OpenAPI Specification
Steve Sfartz, Principal Architect at Cisco
------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
GitHub Gone Wrong - Lessons learned from organic open sourceAll Things Open
Presented by: Charles Eckel
Presented at the All Things Open 2021
Raleigh, NC, USA
Raleigh Convention Center
Abstract: Creating a GitHub organization with public repos is free, fast, and easy. This fosters a wild west of GitHub usage within corporations that is as confusing and troubling as it is liberating and empowering. We explore how GitHub has been used organically throughout Cisco and efforts to establish best practices that enable efficient open source collaboration that is responsible and sustainable.
Accelerating DevOps at the SF DevOps MeetUpjwi11iams
The Codenvy slide presentation given on September 28, 2015 at the SF DevOps MeetUp. This talk covered Codenvy's journey to continuous development and how Codenvy helps accelerate DevOps though increasing code commits and feedback iterations.
Docker Birthday #3 - Intro to Docker SlidesDocker, Inc.
High level overview of Docker + Birthday #3 overview (app and challenge portion)!
Learn more about Docker Birthday #3 celebrations here: https://www.docker.com/community/docker-birthday-3
Topics of this presentation:
- Basics and best practices of developing single-page applications (SPA) and Web API Services on Microsoft .NET -
- Core with Docker and Linux.
- PowerShell Core automated builds.
- Markdown/PDF documentation.
- Documentation of public interfaces with Swagger/OAS/YAML.
- Automated testing of SPA on Protractor and testing the Web API on Postman/Newman.
This presentation by Sergii Fradkov (Consultant, Engineering), Andrii Zarharov (Lead Software Engineer, Consultant), Igor Magdich (Lead Test Engineer, Consultant) was delivered at GlobalLogic Kharkiv .NET TechTalk #1 on May 24, 2019.
Deploy and Update Jakarta EE & MicroProfile applications with Paketo.pptxJamie Coleman
More developers are using Polyglot programming models with their application architecture and why should they not use the language that makes sense for a specific task. This is where we introduce Paketo, the open-source tool that enables a developer to automatically detect what language they are using and build a runnable container image with that application and a runtime to run said application.
In this talk we will talk about what Paketo’s goals are, the benefits it can bring and a demo of how to easily get started taking a MicroProfile and Jakarta EE application and deploy it in a container using Paketo with the Open Liberty Runtime.
Apidays Paris 2023 - Managing OpenAPI Documents at Scale, Stéve Sfartz, Ciscoapidays
Apidays Paris 2023 - Software and APIs for Smart, Sustainable and Sovereign Societies
December 6, 7 & 8, 2023
Managing OpenAPI Documents at Scale
Stéve Sfartz, Principal Architect, API at Cisco
------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Continuous integration and continuous delivery (CI/CD) enables an organization to rapidly iterate on software changes while maintaining stability, performance, and security. Many organizations have adopted various tools to follow the best practices around CI/CD to improve developer productivity, code quality, and software delivery. However, following the best practices of CI/CD is still challenging for many big data teams.
This webinar will highlight:
*Key challenges in building a data pipeline for CI/CD.
*Key integration points in a data pipeline's CI/CD cycle.
*How Databricks facilitates iterative development, continuous integration and build.
Achieving Full Stack DevOps at Colonial Life DevOps.com
In an ever more competitive marketplace, organizations have turned to Agile and DevOps practices to deliver software innovations to market more quickly and with high quality. Across industries, companies are making heavy investments in tools and process improvements around automated build, test, continuous integration and delivery, and release automation and orchestration. However, despite these investments, many organizations are still struggling to bring the necessary speed and quality to their software delivery. In many cases, this is because Agile and DevOps improvements have not been applied to the entire software stack and are often limited to application code delivery.
This webinar will explore the transformation that Colonial Life made in bringing DevOps to the entire software stack. Specifically, beyond automating and accelerating the validation and delivery of application code, this webinar will focus on the critical role that data and the database play in modern software delivery and the tools and processes that can bring the same automation to database code.
After this webinar, you will understand:
* What holds organizations back despite an Agile application development process
* The benefits of automating the validation and deployment of database changes
* A template for bringing DevOps to the entire software stack
Join to learn programming with React and Cisco Collaboration Devices API: listen to ‘RoomAnalytics’ events sent by each device’s Camera and update a provided React map to show how many developers join some workshops. Then, you’ll learn to create custom Controls and deploy Javascript Macros onto the devices.
Industrializing Machine Learning on an Enterprise Azure Platform with Databri...Databricks
<p>Sodexo as the world leader of services, we believe that quality of life is created when we integrate our Food services, Facilities management, employee benefits and more… Our ambition is to positively impact one billion consumers worldwide. Sodexo has launched a POC for food services that is satisfying our business, but how do we come from a local pure Python Jupyter notebook to a product that can be scalable to cover all our consumers? To do so we have not only used DataBricks but we have made it interacting with many Azure services: Data Factory, Log Analytics, DevOps, CosmosDB, Kubernetes, Data Lake and Key Vault. This talk deal about what are those services, how we use Databricks, how it’s interacting with those services, and what are our feedbacks and experiences.</p>
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsPronovix
It's time to take the bias out of code, UI, docs, configurations, or our everyday language by ensuring we choose our words carefully to avoid harmful subtext or exclusion. We can do our part and take steps by examining assets from code to config files to API specifications to standards.
Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods that it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language?
First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool.
What's in the future for these efforts? Inclusive language should expand beyond English and North America efforts. To do so, let's organize the work with automation tooling, as engineers do.
PittsburgJUG_Cloud-Native Dev Tools: Bringing the cloud back to earthGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
Guidelines for Working with Contract Developers in Evergreenloriayre
Slides from presentation on Application Development from Evergreen International Conference 2012. Jed Moffitt also participated in the presentation but he had no slides so these are just the slides from Lori Ayre's portion. Handouts included a sample Development Plan and contract (http://www.slideshare.net/loriayre/development-contract-sample)
Webex Teams Widgets Technical Drill down - Cisco Live Orlando 2018 - DEVNET-3891Cisco DevNet
The React library for Webex Teams (formally Cisco Spark) allows developers to easily incorporate Cisco Cloud Collaboration capabitilies into your application.
Throughout this session, we'll describe the architecture of the Webex Widgets, and detail how to start from the existing React opensource project on github to create a customized version of the Webex Teams Widgets.
DEVNET-3891
https://www.ciscolive.com/us/learn/sessions/session-catalog/?search=DEVNET-3891
Enterprise-Grade DevOps Solutions for a Start Up BudgetDevOps.com
Even though you’re a small startup or medium-sized business and just beginning your product journey, it doesn’t mean you can’t have a robust and scalable DevOps environment like the enterprise experts. It is always a good practice when building a startup or a new company to have a solid foundation and start implementing efficient and scalable solutions early. Join and learn how having a limited budget doesn’t mean you can’t have enterprise quality tools.
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsAnne Gentle
Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language?
First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool.
What's in the future for these efforts? Inclusive language should expand beyond English and North American efforts. To do so, let's organize the work with automation tooling, as engineers do.
What happens when smart developers build sites automatically? Explore webhooks to automate building web sites with modern development techniques. Do you want to learn how to build your own IT doc system? Record your network configurations, infrastructure docs, or collaborate on a wiki - all programmatically. Continuous deployment (CD) lets you build the docs on another system and then place the files where the web server can serve them. CD can include both the building of the HTML files as well as deploying them to a host. Continuous deployment and automation is game-changing for web sites. You can get free or super inexpensive hosting, make sure that all your pull requests build correctly, and make gorgeous web sites, all with automated builds. These services manage setting up the web server, certificates, and domain set up so you can focus on writing down your docs. Webhooks are a mechanism for triggering an event based on a change in a repository. That repository can contain documentation, configuration files, even runbooks that you can link to from the docs pages. You can choose from different services that provide webhooks to build your site automatically.
More Related Content
Similar to Docs as Code: Publishing Processes for API Experiences
Topics of this presentation:
- Basics and best practices of developing single-page applications (SPA) and Web API Services on Microsoft .NET -
- Core with Docker and Linux.
- PowerShell Core automated builds.
- Markdown/PDF documentation.
- Documentation of public interfaces with Swagger/OAS/YAML.
- Automated testing of SPA on Protractor and testing the Web API on Postman/Newman.
This presentation by Sergii Fradkov (Consultant, Engineering), Andrii Zarharov (Lead Software Engineer, Consultant), Igor Magdich (Lead Test Engineer, Consultant) was delivered at GlobalLogic Kharkiv .NET TechTalk #1 on May 24, 2019.
Deploy and Update Jakarta EE & MicroProfile applications with Paketo.pptxJamie Coleman
More developers are using Polyglot programming models with their application architecture and why should they not use the language that makes sense for a specific task. This is where we introduce Paketo, the open-source tool that enables a developer to automatically detect what language they are using and build a runnable container image with that application and a runtime to run said application.
In this talk we will talk about what Paketo’s goals are, the benefits it can bring and a demo of how to easily get started taking a MicroProfile and Jakarta EE application and deploy it in a container using Paketo with the Open Liberty Runtime.
Apidays Paris 2023 - Managing OpenAPI Documents at Scale, Stéve Sfartz, Ciscoapidays
Apidays Paris 2023 - Software and APIs for Smart, Sustainable and Sovereign Societies
December 6, 7 & 8, 2023
Managing OpenAPI Documents at Scale
Stéve Sfartz, Principal Architect, API at Cisco
------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Continuous integration and continuous delivery (CI/CD) enables an organization to rapidly iterate on software changes while maintaining stability, performance, and security. Many organizations have adopted various tools to follow the best practices around CI/CD to improve developer productivity, code quality, and software delivery. However, following the best practices of CI/CD is still challenging for many big data teams.
This webinar will highlight:
*Key challenges in building a data pipeline for CI/CD.
*Key integration points in a data pipeline's CI/CD cycle.
*How Databricks facilitates iterative development, continuous integration and build.
Achieving Full Stack DevOps at Colonial Life DevOps.com
In an ever more competitive marketplace, organizations have turned to Agile and DevOps practices to deliver software innovations to market more quickly and with high quality. Across industries, companies are making heavy investments in tools and process improvements around automated build, test, continuous integration and delivery, and release automation and orchestration. However, despite these investments, many organizations are still struggling to bring the necessary speed and quality to their software delivery. In many cases, this is because Agile and DevOps improvements have not been applied to the entire software stack and are often limited to application code delivery.
This webinar will explore the transformation that Colonial Life made in bringing DevOps to the entire software stack. Specifically, beyond automating and accelerating the validation and delivery of application code, this webinar will focus on the critical role that data and the database play in modern software delivery and the tools and processes that can bring the same automation to database code.
After this webinar, you will understand:
* What holds organizations back despite an Agile application development process
* The benefits of automating the validation and deployment of database changes
* A template for bringing DevOps to the entire software stack
Join to learn programming with React and Cisco Collaboration Devices API: listen to ‘RoomAnalytics’ events sent by each device’s Camera and update a provided React map to show how many developers join some workshops. Then, you’ll learn to create custom Controls and deploy Javascript Macros onto the devices.
Industrializing Machine Learning on an Enterprise Azure Platform with Databri...Databricks
<p>Sodexo as the world leader of services, we believe that quality of life is created when we integrate our Food services, Facilities management, employee benefits and more… Our ambition is to positively impact one billion consumers worldwide. Sodexo has launched a POC for food services that is satisfying our business, but how do we come from a local pure Python Jupyter notebook to a product that can be scalable to cover all our consumers? To do so we have not only used DataBricks but we have made it interacting with many Azure services: Data Factory, Log Analytics, DevOps, CosmosDB, Kubernetes, Data Lake and Key Vault. This talk deal about what are those services, how we use Databricks, how it’s interacting with those services, and what are our feedbacks and experiences.</p>
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsPronovix
It's time to take the bias out of code, UI, docs, configurations, or our everyday language by ensuring we choose our words carefully to avoid harmful subtext or exclusion. We can do our part and take steps by examining assets from code to config files to API specifications to standards.
Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods that it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language?
First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool.
What's in the future for these efforts? Inclusive language should expand beyond English and North America efforts. To do so, let's organize the work with automation tooling, as engineers do.
PittsburgJUG_Cloud-Native Dev Tools: Bringing the cloud back to earthGrace Jansen
How can we effectively develop for the cloud, when we as developers are coding back down on earth? This is where effective cloud-native developer tools can enable us to either be transported into the cloud or alternatively, to bring the cloud back down to earth. But what tools should we be using for this? In this session, we’ll explore some of the useful OSS tools and technologies that can used by developers to effectively develop, design and test cloud-native Java applications.
Guidelines for Working with Contract Developers in Evergreenloriayre
Slides from presentation on Application Development from Evergreen International Conference 2012. Jed Moffitt also participated in the presentation but he had no slides so these are just the slides from Lori Ayre's portion. Handouts included a sample Development Plan and contract (http://www.slideshare.net/loriayre/development-contract-sample)
Webex Teams Widgets Technical Drill down - Cisco Live Orlando 2018 - DEVNET-3891Cisco DevNet
The React library for Webex Teams (formally Cisco Spark) allows developers to easily incorporate Cisco Cloud Collaboration capabitilies into your application.
Throughout this session, we'll describe the architecture of the Webex Widgets, and detail how to start from the existing React opensource project on github to create a customized version of the Webex Teams Widgets.
DEVNET-3891
https://www.ciscolive.com/us/learn/sessions/session-catalog/?search=DEVNET-3891
Enterprise-Grade DevOps Solutions for a Start Up BudgetDevOps.com
Even though you’re a small startup or medium-sized business and just beginning your product journey, it doesn’t mean you can’t have a robust and scalable DevOps environment like the enterprise experts. It is always a good practice when building a startup or a new company to have a solid foundation and start implementing efficient and scalable solutions early. Join and learn how having a limited budget doesn’t mean you can’t have enterprise quality tools.
Similar to Docs as Code: Publishing Processes for API Experiences (20)
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsAnne Gentle
Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language?
First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool.
What's in the future for these efforts? Inclusive language should expand beyond English and North American efforts. To do so, let's organize the work with automation tooling, as engineers do.
What happens when smart developers build sites automatically? Explore webhooks to automate building web sites with modern development techniques. Do you want to learn how to build your own IT doc system? Record your network configurations, infrastructure docs, or collaborate on a wiki - all programmatically. Continuous deployment (CD) lets you build the docs on another system and then place the files where the web server can serve them. CD can include both the building of the HTML files as well as deploying them to a host. Continuous deployment and automation is game-changing for web sites. You can get free or super inexpensive hosting, make sure that all your pull requests build correctly, and make gorgeous web sites, all with automated builds. These services manage setting up the web server, certificates, and domain set up so you can focus on writing down your docs. Webhooks are a mechanism for triggering an event based on a change in a repository. That repository can contain documentation, configuration files, even runbooks that you can link to from the docs pages. You can choose from different services that provide webhooks to build your site automatically.
When you treat docs like code, you multiply everyone’s efforts and streamline processes through collaboration, automation, and innovation. The benefits are real, but these efforts are complex. The ways you can leverage developer process and tools vary widely. Let’s unpack the absolute best situation for using a docs as code model.
Then, we can walk through multiple considerations that may point you in one direction or another. We can talk about version control, publishing, REST API considerations, source formats, automation, quality controls and testing, and lessons learned. Let’s study best practices that are outcome-dependent and situational, creating strategic efforts.
When Infrastructure becomes so reliable it's boring, apps can shine. Here's how to learn more about configuration management and application deployment for OpenStack clouds like Cisco Metacloud. Delivered at the OpenStack Summit in Barcelona, October 2016.
Journey into Continuous Glucose Monitoring Technology as a ParentAnne Gentle
In this lightning talk, Anne Gentle draws on her experiences as a parent to discuss the current state of kids' wearable devices, stories, and experiences from a parent's perspective. Hear about both open source and proprietary solutions for using and displaying medical data such as continuous glucose monitoring. See how cloud technologies and NoSQL databases provide parents and kids more sleep and dad to make good decisions.
I have evidence that using git and GitHub for documentation and community doc techniques can give us 300 doc changes in a month. I’ve bet my career on these methods and I want to share with you.
You'll Never Look at Developer Support the Same Way AgainAnne Gentle
Why will I never look at developer support the same way again? Because I've been on the Developer Experience team at Rackspace, and watching and monitoring the many ways that developers ask questions.
After four years of reading documentation comments on the API documents, I have some insights to share. Our support group has built a tool to listen to tagged feeds on Stack Overflow, read the jclouds mailing lists, all with the OpenStack app developer in mind. We monitor stackoverflow.com, serverfault.com, and superuser.com for questions tagged with Rackspace, rackspace-cloud, fog, cloudfiles, jclouds, pyrax, or keystone. At Rackspace we have been supporting cross-cloud SDKs such as Apache jclouds, Node.js pkgcloud, Ruby Fog, Python Pyrax, .NET, and PHP. Let's look at the data from these many places to find out the patterns for application development. What are the most popular? Which are the most pesky? Let's find out.
So You Want to be an OpenStack ContributorAnne Gentle
Our very own Anne Gentle will go through how to contribute to OpenStack, the open source cloud computing project. What is OpenStack? In a sentence, OpenStack provides open source software for building public and private clouds. What does that mean? We're a collection of open source projects written in Python that integrate to help organizations deploy and run clouds for computing, networking, and storage. Here at Rackspace many of our public cloud services are maintained in OpenStack, and we also offer Private Cloud configuration and management for customers to have OpenStack running for them in their data center or ours.
She'll walk through:
What are all these projects?
Where would I begin?
Is it only coding that counts?
What's Stackforge?
What's Gerrit?
What's <fill-in-weird-code-name-here>?
Then we'll do a hands-on workshop to walk through the first-time contributor process. It's a set-it-and-forget-it process but can be intimidating.
Set up a Launchpad account and public key
Set up and install Git
Set up and install git-review
Set up Gerrit
Join the OpenStack Foundation
Sign the CLA
Find something to work on
Create a commit
Send it to review.openstack.org
Wait for reviews
Address reviewers comments
Patch your patch
Become an Active Technical Contributor to OpenStack
Win
At the OpenStack Summit in Portland, OR in April 2013, the Foundation hosted a breakfast for the Women of OpenStack. We gathered together and took a memorable photo, plus attendees got a copy of "Lean In" by Sheryl Sandberg.
Social web for Tech Comm, STC March 2013Anne Gentle
In a world where readers simply expect websites to offer well-connected experiences, technical documentation
teams must consider the possibilities now available to us through collaborative means. Having worked with blogs,
wikis, open source software, and social networking techniques, I want to share what I’ve learned about documentation as conversation. Through my work with the
OpenStack project, I have further refined my approach to technical content strategy with collaborative, community methods. My presentation shares the methods we use with OpenStack, the ways my thinking has changed, pitfalls to avoid, and measurements that help refine the strategy.
OpenStack documentation has a series of documents for administrators and API users. All these documents need to be translated. The continuous development of documents brings difficulties to the translation management, but the process can be automated with continuous integration. This slide deck introduces the process and the technologies used in the translation management during OpenStack document internationalization. It also includes a demo for creating a Chinese version of manuals.
Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf91mobiles
91mobiles recently conducted a Smart TV Buyer Insights Survey in which we asked over 3,000 respondents about the TV they own, aspects they look at on a new TV, and their TV buying preferences.
UiPath Test Automation using UiPath Test Suite series, part 3DianaGray10
Welcome to UiPath Test Automation using UiPath Test Suite series part 3. In this session, we will cover desktop automation along with UI automation.
Topics covered:
UI automation Introduction,
UI automation Sample
Desktop automation flow
Pradeep Chinnala, Senior Consultant Automation Developer @WonderBotz and UiPath MVP
Deepak Rai, Automation Practice Lead, Boundaryless Group and UiPath MVP
Key Trends Shaping the Future of Infrastructure.pdfCheryl Hung
Keynote at DIGIT West Expo, Glasgow on 29 May 2024.
Cheryl Hung, ochery.com
Sr Director, Infrastructure Ecosystem, Arm.
The key trends across hardware, cloud and open-source; exploring how these areas are likely to mature and develop over the short and long-term, and then considering how organisations can position themselves to adapt and thrive.
GraphRAG is All You need? LLM & Knowledge GraphGuy Korland
Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs.
1. Unifying Large Language Models and Knowledge Graphs: A Roadmap.
https://arxiv.org/abs/2306.08302
2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs:
https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/
State of ICS and IoT Cyber Threat Landscape Report 2024 previewPrayukth K V
The IoT and OT threat landscape report has been prepared by the Threat Research Team at Sectrio using data from Sectrio, cyber threat intelligence farming facilities spread across over 85 cities around the world. In addition, Sectrio also runs AI-based advanced threat and payload engagement facilities that serve as sinks to attract and engage sophisticated threat actors, and newer malware including new variants and latent threats that are at an earlier stage of development.
The latest edition of the OT/ICS and IoT security Threat Landscape Report 2024 also covers:
State of global ICS asset and network exposure
Sectoral targets and attacks as well as the cost of ransom
Global APT activity, AI usage, actor and tactic profiles, and implications
Rise in volumes of AI-powered cyberattacks
Major cyber events in 2024
Malware and malicious payload trends
Cyberattack types and targets
Vulnerability exploit attempts on CVEs
Attacks on counties – USA
Expansion of bot farms – how, where, and why
In-depth analysis of the cyber threat landscape across North America, South America, Europe, APAC, and the Middle East
Why are attacks on smart factories rising?
Cyber risk predictions
Axis of attacks – Europe
Systemic attacks in the Middle East
Download the full report from here:
https://sectrio.com/resources/ot-threat-landscape-reports/sectrio-releases-ot-ics-and-iot-security-threat-landscape-report-2024/
Epistemic Interaction - tuning interfaces to provide information for AI supportAlan Dix
Paper presented at SYNERGY workshop at AVI 2024, Genoa, Italy. 3rd June 2024
https://alandix.com/academic/papers/synergy2024-epistemic/
As machine learning integrates deeper into human-computer interactions, the concept of epistemic interaction emerges, aiming to refine these interactions to enhance system adaptability. This approach encourages minor, intentional adjustments in user behaviour to enrich the data available for system learning. This paper introduces epistemic interaction within the context of human-system communication, illustrating how deliberate interaction design can improve system understanding and adaptation. Through concrete examples, we demonstrate the potential of epistemic interaction to significantly advance human-computer interaction by leveraging intuitive human communication strategies to inform system design and functionality, offering a novel pathway for enriching user-system engagements.
JMeter webinar - integration with InfluxDB and GrafanaRTTS
Watch this recorded webinar about real-time monitoring of application performance. See how to integrate Apache JMeter, the open-source leader in performance testing, with InfluxDB, the open-source time-series database, and Grafana, the open-source analytics and visualization application.
In this webinar, we will review the benefits of leveraging InfluxDB and Grafana when executing load tests and demonstrate how these tools are used to visualize performance metrics.
Length: 30 minutes
Session Overview
-------------------------------------------
During this webinar, we will cover the following topics while demonstrating the integrations of JMeter, InfluxDB and Grafana:
- What out-of-the-box solutions are available for real-time monitoring JMeter tests?
- What are the benefits of integrating InfluxDB and Grafana into the load testing stack?
- Which features are provided by Grafana?
- Demonstration of InfluxDB and Grafana using a practice web application
To view the webinar recording, go to:
https://www.rttsweb.com/jmeter-integration-webinar
Slack (or Teams) Automation for Bonterra Impact Management (fka Social Soluti...Jeffrey Haguewood
Sidekick Solutions uses Bonterra Impact Management (fka Social Solutions Apricot) and automation solutions to integrate data for business workflows.
We believe integration and automation are essential to user experience and the promise of efficient work through technology. Automation is the critical ingredient to realizing that full vision. We develop integration products and services for Bonterra Case Management software to support the deployment of automations for a variety of use cases.
This video focuses on the notifications, alerts, and approval requests using Slack for Bonterra Impact Management. The solutions covered in this webinar can also be deployed for Microsoft Teams.
Interested in deploying notification automations for Bonterra Impact Management? Contact us at sales@sidekicksolutionsllc.com to discuss next steps.
UiPath Test Automation using UiPath Test Suite series, part 4DianaGray10
Welcome to UiPath Test Automation using UiPath Test Suite series part 4. In this session, we will cover Test Manager overview along with SAP heatmap.
The UiPath Test Manager overview with SAP heatmap webinar offers a concise yet comprehensive exploration of the role of a Test Manager within SAP environments, coupled with the utilization of heatmaps for effective testing strategies.
Participants will gain insights into the responsibilities, challenges, and best practices associated with test management in SAP projects. Additionally, the webinar delves into the significance of heatmaps as a visual aid for identifying testing priorities, areas of risk, and resource allocation within SAP landscapes. Through this session, attendees can expect to enhance their understanding of test management principles while learning practical approaches to optimize testing processes in SAP environments using heatmap visualization techniques
What will you get from this session?
1. Insights into SAP testing best practices
2. Heatmap utilization for testing
3. Optimization of testing processes
4. Demo
Topics covered:
Execution from the test manager
Orchestrator execution result
Defect reporting
SAP heatmap example with demo
Speaker:
Deepak Rai, Automation Practice Lead, Boundaryless Group and UiPath MVP
Accelerate your Kubernetes clusters with Varnish CachingThijs Feryn
A presentation about the usage and availability of Varnish on Kubernetes. This talk explores the capabilities of Varnish caching and shows how to use the Varnish Helm chart to deploy it to Kubernetes.
This presentation was delivered at K8SUG Singapore. See https://feryn.eu/presentations/accelerate-your-kubernetes-clusters-with-varnish-caching-k8sug-singapore-28-2024 for more details.
Connector Corner: Automate dynamic content and events by pushing a buttonDianaGray10
Here is something new! In our next Connector Corner webinar, we will demonstrate how you can use a single workflow to:
Create a campaign using Mailchimp with merge tags/fields
Send an interactive Slack channel message (using buttons)
Have the message received by managers and peers along with a test email for review
But there’s more:
In a second workflow supporting the same use case, you’ll see:
Your campaign sent to target colleagues for approval
If the “Approve” button is clicked, a Jira/Zendesk ticket is created for the marketing design team
But—if the “Reject” button is pushed, colleagues will be alerted via Slack message
Join us to learn more about this new, human-in-the-loop capability, brought to you by Integration Service connectors.
And...
Speakers:
Akshay Agnihotri, Product Manager
Charlie Greenberg, Host
Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024Tobias Schneck
As AI technology is pushing into IT I was wondering myself, as an “infrastructure container kubernetes guy”, how get this fancy AI technology get managed from an infrastructure operational view? Is it possible to apply our lovely cloud native principals as well? What benefit’s both technologies could bring to each other?
Let me take this questions and provide you a short journey through existing deployment models and use cases for AI software. On practical examples, we discuss what cloud/on-premise strategy we may need for applying it to our own infrastructure to get it to work from an enterprise perspective. I want to give an overview about infrastructure requirements and technologies, what could be beneficial or limiting your AI use cases in an enterprise environment. An interactive Demo will give you some insides, what approaches I got already working for real.
3. Define docs as code
GitHub or GitLab as a CMS
(Content Management System)
Version control for documentation source files (close to code)
Automatic builds for docs
Test the docs (close to code)
Review with technical collaborators
Merge the docs
Continuous integration, continuous deployment
Publish (possibly automatically after requirements are met)
Repeat
11. Landing pages and dev centers:
XML, HTML
Technical documentation:
Markdown, JSON, HTML
Interactive API documentation:
OpenAPI specification
(YAML or JSON)
Interactive tutorials: Dockerfile, code
Pages on developer.cisco.com
Developer content
Collaborators on the book, Diane Skwish and Kelly Holcomb, had been on a couple of teams making this shift. Eric Holscher was a co-founder of the Write the Docs community. We had a lot of observations and wanted to share.
Store the doc source files in a version control system. Keep them as close to the code as possible.
Consider files as truly source, not output, for simplicity in authoring and reviewing.
Build the doc artifacts automatically.
Make builds so low-cost that you can repeatedly and reliably build every time you make a change. Continuous integration.
Ensure that a trusted set of reviewers meticulously reviews the docs – source and output.
Publish the artifacts without much human intervention.
How do teams publish their documentation on developer.cisco.com?
How many pages get updated a week on DevNet? Who are the authors and what tools do they use? Learn all this and get any other questions answered in this technical session about how DevNet treats docs like code. When you treat docs like code, you multiply everyone’s efforts and streamline processes through coordination, automation, and production using developer tools. The benefits are real, and these efforts may seem complex, so let's unpack version control, publishing, REST API documentation, source formats, automation, quality controls and testing, and lessons learned.
Cisco Business Unit representative fills out onboarding form
Adrienne Moherek from my team meets with the product team, tech writers, others to learn more
Team may need infrastructure like a Sandbox for hands-on environments
Team gets trained on PubHub
Wide Range of Content Contributors
Developers, SME, Web Designers, Professional Tech writers etc.
Self-Service to scale (low touch)
Good review/approval flow for maintain content quality.
Low barrier to authoring
Continuous update and publishing flow
Wide Range of Content Contributors
Developers, SME, Web Designers, Professional Tech writers etc.
Self-Service to scale (low touch)
Good review/approval flow for maintain content quality.
Low barrier to authoring
Continuous update and publishing flow
Demo
Demo at https://developer.cisco.com/meraki/api-v1/#!get-organizations
Demo at https://developer.cisco.com/learning/
Lead engineer: Neelesh Pateriya
517: Published sites & doc sets
1491: Content Contributors
2175 Projects
≈92k Updates
Using Postman, let’s map the OAS elements into an HTTP request and response. Notice that the ‘paths’ element acts as a bridge for most details about a request and the possible responses that may be returned
Notice the versions at the top and bottom.
Version at the top is the version of the specification
Version in the info section is the version of the API
Pop quiz about versions?
If you have the API service is in the cloud, then use the cloud URL. For example meraki uses https://api.meraki.com/
If the API service is on-premise, than this is where you would include the URL to a DevNet Always-on Sandbox so that developers can make requests to a server.
Operations are defined by a path + HTTP method (aka verb) + input parameters + one or more response details. Operations may also have examples that can assist developers in better understanding how to use the operation effectively
Components help to capture reusable elements that may be referenced within and across OAS files.
Source: https://swagger.io/docs/specification/components/
Schema components define reusable structures for request inputs and response outputs. They are often referenced from operations or from one schema to another. This increases reuse across an API. Likewise, HTTP request and response headers can be reused for things such as conveying rate limits to an API client, authorization token headers, and other important elements
Components help to capture reusable elements that may be referenced within and across OAS files.
Source: https://swagger.io/docs/specification/components/
Schema components define reusable structures for request inputs and response outputs. They are often referenced from operations or from one schema to another. This increases reuse across an API. Likewise, HTTP request and response headers can be reused for things such as conveying rate limits to an API client, authorization token headers, and other important elements
Show best examples and connect the teams to each other. Other ideas?
Four-day training course available for tech writers, product managers, and engineers who RAVE about OAS.
We should probably tackle content testing with a Python tool meant to run the content end-to-end. Other ideas?
Also https://idratherbewriting.com/learnapidoc/docapis_measuring_impact.html
Content input parsing & output publishing is pluggable architecture in pubhub.
Input plugins MD to html, swagger to html, epub html to generic html (recently added) .. other can be added easily.
Output publishing is also plugin based. Added Course output, Learning Lab output plugin in addition to site, doc publishing plugin.
Supported by pubhub-support mailing list – Anne’s team and engineering team.