GitHub as a Landing Page

•

0 recomendaciones•249 vistas

You can write the best, most structured documentation in the world - and your users will still arrive by some other route. This session focuses on the GitHub repos that your documentation references, and how to prepare for these to be the entry point for someone.

Tecnología

GitHub is your
Documentation
Landing Page

Lorna Mitchell, Nexmo

Landing Pages
The homepage of your documentation

A finely crafted experience

@lornajane

Repository Standards

https://github.com/Nexmo/repo-standards
@lornajane

README and GitHub
Client Library for PHP
============================
[![Build Status](https://api.travis-ci.org/Nexmo/nexmo-php.svg?branch=mas
[![Latest Stable Version](https://poser.pugx.org/nexmo/client/v/stable)](
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LI
[![codecov](https://codecov.io/gh/Nexmo/nexmo-php/branch/master/graph/bad
*This library requires a minimum PHP version of 7.1*
This is the PHP client library for use Nexmo's API. To use this, you'll n
nexmo.com][signup].
@lornajane

README and GitHub
GitHub renders documentation on the main repo page
@lornajane

README and GitHub
Package managers use README too (e.g. https://packagist.com)
@lornajane

README Basics
• Project title and short explanation of its purpose and scope
• Link to documentation or other source link for this project
• A bit about Nexmo, including a signup link

• ... the middle section depends on your project type ...

• How to get help (an issue, an email?)
• Links to related resources or further reading
@lornajane

Repo Types
We're working on three distinct types of repository:
• Library Code
• Tool or Demo App
• Supporting Code

... docs-as-code is probably a fourth category
@lornajane

Library Code README
Try these ingredients for a good library README recipe:
• Pre-requisites, such as technology requirements, Nexmo
account
• Installation instructions
• Usage instructions
• the API reference is not enough by itself
• every project needs lots of examples
@lornajane

Installable Item README
For Apps/Demos, use the Library recipe, with extra ingredients
• Pre-requisites, such as technology requirements, Nexmo
account
• Installation instructions
• Usage instructions
• Deployment instructions
• a docker setup
• "click to deploy" e.g. Heroku
@lornajane

Supporting Code README
If the code was really just shared to accompany something else:
• Link to the thing it is for

... anything else is a bonus :)
@lornajane

README Furniture
Use headings and a table of contents to help users navigate longer
READMEs

@lornajane

Repo Metadata
Give your project a clear name!
• Description is key because it shows in search results
• Use the topics to help indicate both technology and features

@lornajane

Give Permission
Every project needs a LICENSE.md without which nobody can use
your project anyway

Use a standard (OSI) and make sure GitHub has recognised it.

@lornajane

Welcome Participation
Help users to participate
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
@lornajane

GitHub is Your Landing Page
Welcome and orient your user, however they reached you.

@lornajane

Resources and Further Reading
• https://github.com/nexmo
• https://lornajane.net
• https://stoplight.io/blog/open-source-documentation/
• https://github.com/ekalinin/github-markdown-toc.go
• https://opensource.org/licenses
@lornajane

Más contenido relacionado

La actualidad más candente

Continuous Delivery session from deliver:Agile As your Agile team looks to shorten the cycle time from idea to production, it is important to give them the tools that will enable continuous feedback, collaboration with stakeholders, and most importantly, a way to get the product in front of the customer and enable a feedback loop. This session will teach you how to create an effective release pipeline that incorporates Continuous Integration, automated testing, cloud deployment with Infrastructure as Code, Instrumentation, load testing, and more. We will go from zero to Production in less than an hour and you will go back to work on Monday ready to deploy! Learning Outcomes: Continuous Integration Continuous Deployment Automation

deliver:agile - Enable your Agile Team with Continuous Delivery Pipelines

Esteban Garcia

Creating Interactive Docs with Postman

Pronovix

O365Con18 - Git and GitHub - Rick van Rousselt

NCCOMMS

Nativescript

Software Infrastructure

NativeScript + Push Notifications

Lohith Goudagere Nagaraj

Native Script by Sebastian Witalec

Simone Basso

TypeScript

Software Infrastructure

How to Supercharge your PHP Web API

Aurimas Niekis

Designing APIs with OpenAPI Spec

Adam Paxton

NativeScript Developer Day Keynote - Todd Anglin & Burke Holland

Brian Rinaldi

How to write your own Slack Chatbots in Javascript Through conversational experiences people can interact with applications easier than ever before. For developers this means they have to understand how to build these natural user interfaces in addition to browser interfaces and mobile apps. In this session we will demonstrate live how to develop a chatbot for Slack. Via Node.js and the open source project botkit we’ll connect to Slack’s websocket API. In order to define the conversation flow we’ll leverage intents, entities and dialogs from IBM Watson’s Conversation service. https://github.com/nheidloff/slack-watson-bot https://berlin2017.codemotionworld.com/talk-detail/?detail=6962 https://twitter.com/CodemoBerlin/status/917661008537235461

Writing Slack Bots in JavaScript

Niklas Heidloff

Having around 1.3 years of experience in Unit Testing field which mainly include Test automation.Involved in Preparation of Module Test Specification for C Functions using White Box Testing Methodology.Experience in Component testing each module of the HeliTrak Helicopter Autopilot V&V using RTRT tool. Experience in Implementation of Module Test Specification in Test Script using LDRA and native C Code Sound Knowledge in Equivalence classes, Boundary Value analysis, Decision tables. Experience in Black box Testing, White Box Testing & Grey Box Testing.Experience in Verification & Validation (V&V) as per D0178B Level B guidelines

Mca 02 year_exp_unit_automation_testing_ldra_rtrt_c -

sandeep kumar gupta

The API-first design approach treats APIs as first-class citizens. The entire system or project is built around the idea that components connect via APIs. The first step is, therefore, to design the APIs and their connections. However, there is a gap between the beautiful world of API specifications and the reality of agile development. This gap means that published API specifications are often incomplete, missing examples or simply outdated. The API specification meant to help developers can be a thorn in one’s side because keeping the specification in sync with its implementation is a manual process, tedious and prone to be forgotten during the rush to deliver. We show how this gap can be bridged effectively using the API specification as the only source of truth driving the API implementation with proven tools enabling automation.

API-first development

Vasco Veloso

Get Your Node.js API Swaggering with OpenAPI Spec

Adam Paxton

Introduction to NativeScript - BuildTruly Native Apps using JavaScript

Lohith Goudagere Nagaraj

ASP.NET

Chandan Gupta Bhagat

In this session, Massimo will go through the Swagger specification and some open source tools built on top of Swagger. This includes Swagger editors and how they can be used to create our API stubs, the Swashbuckle tool to auto-generate swagger.json, to keep it in sync with the server code and to make it discoverable. Finally he will demonstrate the Swagger integration in the API Management space (Azure API Management and Sentinet).

Everybody loves Swagger

BizTalk360

API Documentation plays an important role in improving the customer’s experience with APIs, which is always a struggle for most of the company. The way to accomplish this is to transition API development culture from “Code First” to “Design First”, here in SAS we call it “API First”. For better API designing and documentation, we have built an API First CI/CD workflow which brings many open-sourced API tools together and involves developers, product managers, documentation writers, and testers to synchronously work together to develop APIs in a “Design First” approach, the industry standard. In the talk, we will discuss how the API-first Workflow could enable better collaboration between teams which could help in many aspects especially writing the openAPI documentation, keeping it up to date and sync with your code. We will take a deep look at one example, the Linting tool from API First workflow, which helps to make sure the API documentation follows the company standard from the start. With openSource linting tools like Spectral, it’s easy for teams to define their own linting rules which includes company standards. When your API specifications go through the linter in the CI/CD pipeline, the linter will throw errors and warnings as you write your spec. This will help ensure your specification is following proper guidelines and that’s all automatic.

API First Workflow: How could we have better API Docs through DevOps pipeline

Pronovix

Platforms FTW!

Matt O'Keefe

La actualidad más candente (19)

deliver:agile - Enable your Agile Team with Continuous Delivery Pipelines

Creating Interactive Docs with Postman

O365Con18 - Git and GitHub - Rick van Rousselt

Nativescript

NativeScript + Push Notifications

Native Script by Sebastian Witalec

TypeScript

How to Supercharge your PHP Web API

Designing APIs with OpenAPI Spec

NativeScript Developer Day Keynote - Todd Anglin & Burke Holland

Writing Slack Bots in JavaScript

Mca 02 year_exp_unit_automation_testing_ldra_rtrt_c -

API-first development

Get Your Node.js API Swaggering with OpenAPI Spec

Introduction to NativeScript - BuildTruly Native Apps using JavaScript

ASP.NET

Everybody loves Swagger

API First Workflow: How could we have better API Docs through DevOps pipeline

Platforms FTW!

Similar a GitHub as a Landing Page

Let's build Developer Portal with Backstage

Opsta

Habitat Overview

Mandi Walls

Web development with Python

Raman Balyan

Habitat Workshop at Velocity London 2017

Mandi Walls

The Web is a vital part of our daily lives, and as we begin using the Web for tasks traditionally performed on the desktop, such as word processing, software as a service (SaaS) and software + services models are becoming more important. Web developers are caught in the cross hairs of these merging industries. They have the know-how of web development but, often, none of the skills for traditional desktop or mobile development. Enter Titanium. Appcelerator Titanium is an open source platform for developing native desktop and mobile applications using the web technologies you're already familiar with. Now, web developers can use their skills to develop for both the Web and desktop/mobile platforms. Ben Ramsey will demonstrate how to create a simple application in Titanium Desktop, showing examples using JavaScript and PHP working together in the Titanium run time environment to power dynamic desktop applications that communicate easily with external web services.

Desktop Apps with PHP and Titanium

Ben Ramsey

Bringing Dev and Ops together with ChatOps

Jaap Brasser

Deliver Python Apps with Docker

Anton Egorov

API workshop: Introduction to APIs (TC Camp)

Tom Johnson

Terraform AWS modules and some best practices - September 2019

Anton Babenko

python full stack course in hyderabad...

sowmyavibhin

python full stack course in hyderabad...

sowmyavibhin

Continuous Integration with Open Source Tools - PHPUgFfm 2014-11-20

Michael Lihs

Composer Lightning Talk

Eric Johnson

When OpenNTF began in 2001, source control was little known and sharing of code via the cloud was limited. Fast forward 20 years and GitHub is the dominant sharing site and git the standard technology for source control. In this webinar Paul Withers and Jesse Gallagher will: Demystify git Explain Branching Show what makes a high quality repository How to take advantage of GitHub’s broad functionality Get that coveted "Verified" badge Go from source control zero to GitHub hero!

August OpenNTF Webinar - Git and GitHub Explained

Howard Greenberg

Containerdays Intro to Habitat

Mandi Walls

They why behind php frameworks

Kirk Madera

Robot framework Gowthami Goli

Gowthami Buddi

In my talk I will discuss and show examples of using Apache Hadoop, Apache Hive, Apache MXNet, Apache OpenNLP, Apache NiFi and Apache Spark for deep learning applications. This is the follow up to last years Apache Deep Learning 101 that was done at Dataworks Summit and ApacheCon. As part of my talk I will walk through using Apache NXNet Pre-Built Models, MXNet's New Model Server with Apache NiFi, executing MXNet with Apache NiFi and running Apache MXNet on edge nodes utilizing Python and Apache MiniFi. This talk is geared towards Data Engineers interested in the basics of Deep Learning with open source Apache tools in a Big Data environment. I will walk through source code examples available in github and run the code live on an Apache Hadoop / YARN / Apache Spark cluster. This will be an introduction to executing Deep Learning Pipelines in an Apache Big Data environment. My talk at Data Works Summit Sydney was listed in top 7 -> https://hortonworks.com/blog/7-sessions-dataworks-summit-sydney-see/ Also have speak at and run Future of Data Princeton and at Oracle Code NYC. https://www.slideshare.net/oom65/hadoop-security-architecture?next_slideshow=1 https://community.hortonworks.com/articles/83100/deep-learning-iot-workflows-with-raspberry-pi-mqtt.html https://community.hortonworks.com/articles/146704/edge-analytics-with-nvidia-jetson-tx1-running-apac.html https://dzone.com/refcardz/introduction-to-tensorflow

Apache Deep Learning 201

DataWorks Summit

CT Software Developers Meetup: Using Docker and Vagrant Within A GitHub Pull ...

E. Camden Fisher

YouTube Link: https://youtu.be/7bGOXbqhaow ** Python Certification Training: https://www.edureka.co/python ** This Edureka video on 'Best Python IDEs' is to educate you about the Top 10 Best IDEs for Python and how to choose the one that is most suitable for you. Below are the topics covered in this video: What is an IDE? Features of an IDE Top 10 Best IDEs for Python Python Tutorial Playlist: https://goo.gl/WsBpKe Blog Series: http://bit.ly/2sqmP4s Follow us to never miss an update in the future. YouTube: https://www.youtube.com/user/edurekaIN Instagram: https://www.instagram.com/edureka_learning/ Facebook: https://www.facebook.com/edurekaIN/ Twitter: https://twitter.com/edurekain LinkedIn: https://www.linkedin.com/company/edureka Castbox: https://castbox.fm/networks/505?country=in

Top 10 IDEs for Python | Edureka

Edureka!

Similar a GitHub as a Landing Page (20)

Let's build Developer Portal with Backstage

Habitat Overview

Web development with Python

Habitat Workshop at Velocity London 2017

Desktop Apps with PHP and Titanium

Bringing Dev and Ops together with ChatOps

Deliver Python Apps with Docker

API workshop: Introduction to APIs (TC Camp)

Terraform AWS modules and some best practices - September 2019

python full stack course in hyderabad...

Continuous Integration with Open Source Tools - PHPUgFfm 2014-11-20

Composer Lightning Talk

August OpenNTF Webinar - Git and GitHub Explained

Containerdays Intro to Habitat

They why behind php frameworks

Robot framework Gowthami Goli

Apache Deep Learning 201

CT Software Developers Meetup: Using Docker and Vagrant Within A GitHub Pull ...

Top 10 IDEs for Python | Edureka

Más de Pronovix

Your relationship with a developer begins before they even know your product's name. In fact, before they know they need a product like yours. In this talk, Matthew will make the case that developer marketing, developer experience, and developer education are part of a continuum. And that if you're thinking of documentation as something that happens only after someone has signed-up for your API, then you're leaving it too late. He'll draw on pedagogical and marketing research to propose a model for the developer learning journey where traditional API documentation is just one stop along the way. Attend this talk and you'll come away with practical ideas for how to start educating developers earlier in their product evaluation and learning journey.

By the time they're reading the docs, it's already too late

Pronovix

Optimizing Dev Portals with Analytics and Feedback

Pronovix

Building our a developer portal may seem easy at the onset with off the shelf options, but when you're building a custom portal to match the needs of your company, it's not as easy. In this session, we'll talk about our process in determining the right places to start with success metrics and features through an early stage feedback back before having customers. You'll see our intention is to tell a story with multiple facets for multiple people, developers, product managers, C suite decision makers etc... Stories around API usage, health, cost, errors and support to provide our users with an overall of their business performance through our APIs.

Success metrics when launching your first developer portal

Pronovix

AI is entering the world of APIs, where API documentation plays a critical role. One of the fundamental challenges is the need to share understanding about an API and keep the knowledge up to date. AI can potentially speed up API integrations dramatically, but it greatly depends on API documentation. Let's explore the emerging approach to employing AI in APIs, discuss its impact on API documentation, and see how changing our way of working with APIs will lead to self-integrating applications.

Documentation, APIs & AI

Pronovix

As content producers, we invest considerable time and effort in developing, packaging, and delivering content that we think our users need. After publishing the content, we hope that users find our content useful. And we often wonder how users really navigate and consume our content. Web page analytics can help us gauge the information needs of our customers, assess their content consumption behavior, and find opportunities to improve our content and how we deliver it. Kumar explores the basics of web analytics, pitfalls of relying too much on web analytics for important decisions, the typical web analytics process, and he will share some guidelines for interpreting web analytics numbers.

Making sense of analytics for documentation pages

Pronovix

Drawing from experiences from open source work and her time at Spotify, Serah’s talk cover the challenges, opportunities and hacks around proactive and reactive monitoring, processing, tracking and acting on stakeholder and community feedback, and argue for the centricity of well-defined feedback loops in improving the overall developer experiences for any product and features you are responsible for.

Feedback cycles and their role in improving overall developer experiences

Pronovix

The main goal of API documentation is to help developers understand how to use an API. With GraphQL, developers often assume it's self-documenting capabilities are sufficient for anyone that consumes their GraphQL API. But did you ever validate this? Good API documentation offers both static and interactive ways to learn how to consume the API. API's that support GraphQL often only come with interactive documentation, in the shape of a GraphiQL Playground. However, the first time you (or your users) use a GraphQL API can be very frustrating as GraphQL APIs typically only have an interactive playground. it increases the complexity for newcomers to GraphQL as it assumes you’re already familiar with GraphQL. But with GraphQL, you’re not limited to just an interactive playground, as you can create static or interactive documentation next to having this playground. This talk explores which forms of documentation you can use and how they add value to your GraphQL API.

GraphQL Isn't An Excuse To Stop Writing Docs

Pronovix

Web3 is one of the fastest-growing spaces on the web right now, with thousands of new projects emerging every week. Each project aims to fill a gap in the space by providing a new technology How do we keep up with documentation, and what should be prioritized for these projects as they scale? Web3, also referred to as the read-write-own web, is a new form of the internet that utilizes technologies such as blockchain networks, cryptocurrency, crypto wallets, and digital assets like NFTs. The Web3 space is growing by the thousands every week, with new projects and technologies constantly emerging. As writers, it can be challenging to navigate through the space, make sense of every piece of new content, and understand what should be written about for others to read, and what will be irrelevant next week. Many of these new technologies are using pieces of code known as smart contracts or interacting with the APIs of multiple applications at once. What documentation are end-users looking for, and what is the most beneficial format for them to read and comprehend all of this new information? In this talk, I'll discuss what I've learned as a Senior Technical Writer for Filebase, a decentralized cloud storage provider at the heart of hundreds of Web3 projects, and what our customers have benefited from the most when it comes to documentation.

API Documentation For Web3

Pronovix

API docs frequently fail to address developers’ needs by omitting common usage scenarios and use cases. Let’s take a look at good and bad practices for documenting API use cases, and take steps to ensure that developers get from our API and docs what they really want. You wrote an API specification, documented your endpoints, and published SDKs. Here’s a question, though: Does your API actually solve your users’ problems? API providers often fail to address common use cases to solve users’ needs, or their assumptions don’t match the reality. This may end up in frustration and loss of users. In this talk, we will take a peek into developers’ mindset. I will show how to better understand the developers’ needs by researching the usage patterns, existing libraries and 3rd party experience layers, provide examples of good and bad practices, and suggest actionable steps to improve developer experience for your API.

Why your API doesn’t solve my problem: A use case-driven API design

Pronovix

unREST among the docs

Pronovix

Nobody likes ambiguity—especially when it comes to the stability of APIs and the expectations for availability long term. Avoid common pitfalls and explore a critical area where trust is built with developers through thoughtful policy and the development of best-in-class documentation. A good deprecation policy involves a lot of forward thinking and an awareness of how developers or end users are currently leveraging your capabilities, and how a given API or feature deprecation could affect them in the future. The hard-earned trust that you’ve built and maintained with these individuals is at risk with any type of policy or documentation that is unclear. The road to developing a clear, trustworthy deprecation policy is a multi-faceted initiative with input from product, engineering, customer success and other cross-functional teams, as well as external market awareness. Knowing which voices to have in the room, what the industry standards are, and formulating appropriate communication timelines will ensure a world class policy is developed and documented before it’s needed. Join us as we dive into the nuances of this process and how to avoid the common pitfalls that come from lacking a strategic, thoughtful approach to documenting a deprecation policy for your APIs.

Developing a best-in-class deprecation policy for your APIs

Pronovix

At MongoDB, we now generate REST API references for MongoDB Atlas from annotations in the product’s source. Our team’s writers proposed, planned, led, and implemented this project–and learned a lot along the way. We’ll share how we got buy-in from engineering and product stakeholders, coordinated the project across teams, implemented swagger-core annotations in Java, and drove positive change to benefit our team, the company, and our users.

Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone

Pronovix

It turns out there is no single answer. Developers may have unique goals, motivations, constraints, and challenges, and all of these influence how they approach the problem in front of them. However, more than a decade ago, three development styles were identified - systematic, pragmatic, and opportunistic - and the academic literature suggests that these still exist today. Two of the three approaches, the systematic and the opportunistic pattern, can be considered as opposite extremes, while the pragmatic approach is situated in between and is similar to both. It is not a personality trait - people may approach a situation one way or another depending on their circumstances, goals, and motivations (however, they may also have a preferred approach, which is usually their characteristic). Understanding the differences between these patterns (and the different needs) helps us to design in a way that serves most of the users, and even helps them to get into a state of flow by providing the optimal level of challenge to solve their problem.

What do developers do when it comes to understanding and using APIs?

Pronovix

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.

Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations

Pronovix

How to create documentation and write code for an international audience, not just the people who speak and think like you. Make your APIs more useful for everyone on the planet. Much of the documentation supplied by both Open Source and Close Souce projects assume the community have a good understanding of the English language and often North American culture as well. This creates barriers for many solution providers, who are the gateway to potentially huge markets for your project. This talk discusses some of the cultural differences, particularly for people from Asia, in using English language API documentation. It suggests some strategies to help diverse audiences understand you APIs and create solutions using them. The talk will cover not only differences in language but also other cultural differences that are often not obvious. For example: Different expectations about publication formats, release processes, levels of support during the development process Meeting and communications styles Software development workflows, processes, and tools Supporting people who are visually impaired will also be briefly discussed. As well as discussing these issues, specific suggestions will be provided to make API docs accessible for as many people as possible. This talk is based on Alec's work with customers in Europe, North America, Middle East, Asia, and Australasia. The last five have been spent as a developer evangelist working with PaperCut partners in China, Japan, Korea, US and Europe.

Creating API documentation for international communities

Pronovix

APIs in a modern enterprise are rarely uniform or all of the same type. The multitude of API types can be due to organic growth, mergers and acquisitions, or any number of other reasons. Regardless of their origin, APIs of all types need to be fully documented to facilitate a developer’s journey as they interact with your API ecosystem in order to develop useful applications. In this talk I will show examples of how we have augmented developer portals to document APIs that are not of the REST variety, such as AsyncAPI, GraphQL, SOAP, gRPC, and more, such that all API documentation can seamlessly live side-by-side.

One Developer Portal to Document Them All

Pronovix

We are a software engineering team creating API docs. Docs are authored using Instructional Design principles to narrate use-cases and practical API implementations. This talk shares why & how we've applied software development practices to evolve our document tooling, creation, & delivery methods. Our APIs describe asynchronous protocols used for embedded software (firmware) components in a digital 2-way radio communications system. The API is protocol data unit (PDU) based and its definition is described in a proprietary format; consequently, well-known API formats, such as Swagger/OpenAPI, or tools, such as doxygen, are not used. Our product training and technical writing teams are very experienced in Instructional Design methods, but these teams have only written documentation for an end-user audience. Understanding software development processes is equally important as understanding two-way radio networks in order to successfully integrate with the APIs. This is the rationale for having a software engineering team develop the skillsets to write API documentation for a developer audience. With a solid foundation of API documentation in place, regular examination of engineering efficiency and developer experience is appropriate. Repeated actions can be replaced by automation. Content can be modular and re-usable. Formats can be streamlined for easier consumption. Docs can be made portable and lightweight for faster delivery.

Docs-as-Code: Evolving the API Documentation Experience

Pronovix

Ever wonder how some products are just lovable and easy to use while other are not? The good products have optimized onboarding into their ecosystem where you get the information served at the right time. That’s thanks to developer journey and we will teach you how to get it right! We will go through the basics such as how to analyze existing and non-existing developer touchpoints, set metrics and optimize them to increase the conversion.

Developer journey - make it easy for devs to love your product

Pronovix

Deliberate Complexity Conferences - 19 JULY 2022 Alicia Juarrero - Complexity is not complicatedness Professor Alicia Juarrero, a leading complexity theory philosopher and academic, as well as the founder and president of VectorAnalytica, a technology company that specializes in large scale scientific data capture and real time analysis tools. Alicia's work in complexity theory is widely quoted by thought leaders in the technology space and referenced in many recent complexity-informed approaches for managing highly dynamic systems, as well as in knowledge management.

Complexity is not complicatedness

Pronovix

How cognitive biases and ranking can foster an ineffective architecture and d...

Pronovix

Más de Pronovix (20)

By the time they're reading the docs, it's already too late

Optimizing Dev Portals with Analytics and Feedback

Success metrics when launching your first developer portal

Documentation, APIs & AI

Making sense of analytics for documentation pages

Feedback cycles and their role in improving overall developer experiences

GraphQL Isn't An Excuse To Stop Writing Docs

API Documentation For Web3

Why your API doesn’t solve my problem: A use case-driven API design

unREST among the docs

Developing a best-in-class deprecation policy for your APIs

Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone

What do developers do when it comes to understanding and using APIs?

Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations

Creating API documentation for international communities

One Developer Portal to Document Them All

Docs-as-Code: Evolving the API Documentation Experience

Developer journey - make it easy for devs to love your product

Complexity is not complicatedness

How cognitive biases and ranking can foster an ineffective architecture and d...

Último

Angeliki Cooney has spent over twenty years at the forefront of the life sciences industry, working out of Wynantskill, NY. She is highly regarded for her dedication to advancing the development and accessibility of innovative treatments for chronic diseases, rare disorders, and cancer. Her professional journey has centered on strategic consulting for biopharmaceutical companies, facilitating digital transformation, enhancing omnichannel engagement, and refining strategic commercial practices. Angeliki's innovative contributions include pioneering several software-as-a-service (SaaS) products for the life sciences sector, earning her three patents. As the Senior Vice President of Life Sciences at Avenga, Angeliki orchestrated the firm's strategic entry into the U.S. market. Avenga, a renowned digital engineering and consulting firm, partners with significant entities in the pharmaceutical and biotechnology fields. Her leadership was instrumental in expanding Avenga's client base and establishing its presence in the competitive U.S. market.

Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...

Angeliki Cooney

In the thrilling conclusion to 2023, ransomware groups had a banner year, really outdoing themselves in the "make everyone's life miserable" department. LockBit 3.0 took gold in the hacking olympics, followed by the plucky upstarts Clop and ALPHV/BlackCat. Apparently, 48% of organizations were feeling left out and decided to get in on the cyber attack action. Business services won the "most likely to get digitally mugged" award, with education and retail nipping at their heels. Hackers expanded their repertoire beyond boring old encryption to the much more exciting world of extortion. The US, UK and Canada took top honors in the "countries most likely to pay up" category. Bitcoins were the currency of choice for discerning hackers, because who doesn't love untraceable money?

Ransomware_Q4_2023. The report. [EN].pdf

Overkill Security

Axa Assurance Maroc - Insurer Innovation Award 2024

The Digital Insurer

When you’re building (micro)services, you have lots of framework options. Spring Boot is no doubt a popular choice. But there’s more! Take Quarkus, a framework that’s considered the rising star for Kubernetes-native Java. It always depends on what's best for your situation, but how to choose the best solution if you're comparing 2 frameworks? Both Spring Boot and Quarkus have their positives and negatives. Let us compare the two by live coding a couple of common use cases in Spring Boot and Quarkus. After this talk, you’ll be ready to get started with Quarkus yourself, and know when to select Quarkus or Spring Boot.

Spring Boot vs Quarkus the ultimate battle - DevoxxUK

Jago de Vreede

Join our latest Connector Corner webinar to discover how UiPath Integration Service revolutionizes API-centric automation in a 'Quote to Cash' process—and how that automation empowers businesses to accelerate revenue generation. A comprehensive demo will explore connecting systems, GenAI, and people, through powerful pre-built connectors designed to speed process cycle times. Speakers: James Dickson, Senior Software Engineer Charlie Greenberg, Host, Product Marketing Manager

Connector Corner: Accelerate revenue generation using UiPath API-centric busi...

DianaGray10

The Good, the Bad and the Governed - Why is governance a dirty word? David O'Neill, Chief Operating Officer - APIContext Apidays New York 2024: The API Economy in the AI Era (April 30 & May 1, 2024) ------ 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/

Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...

apidays

DBX First Quarter 2024 Investor Presentation

Dropbox

2024: Domino Containers - The Next Step. News from the Domino Container commu...

Martijn de Jong

Strategies for Landing an Oracle DBA Job as a Fresher

Remote DBA Services

CNIC Information System with Pakdata Cf In Pakistan

danishmna97

The action of the next cyber saga takes place in the mystical lands of the Asia-Pacific region, where the main characters began their digital activities in the middle of 2021 and qualitatively strengthened it in 2022. Corporate espionage, document theft, audio recordings, and data leaks from messaging platforms were all a matter of one day for Dark Pink. Their geographical focus may have started in the Asia-Pacific region, but their ambitions knew no bounds, targeting a European government ministry in a bold move to expand their portfolio. Their victim profile was as diverse as a UN meeting, targeting military organizations, government agencies, and even a religious organization. Because discrimination is not a fashionable agenda. In the world of cybercrime, they serve as a reminder that sometimes the most serious threats come in the most unassuming packages with a pink bow.

Cyberprint. Dark Pink Apt Group [EN].pdf

Overkill Security

💉💊+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHABI}}+971581248768 +971581248768 Mtp-Kit (500MG) Prices » Dubai [(+971581248768**)] Abortion Pills For Sale In Dubai, UAE, Mifepristone and Misoprostol Tablets Available In Dubai, UAE CONTACT DR.Maya Whatsapp +971581248768 We Have Abortion Pills / Cytotec Tablets /Mifegest Kit Available in Dubai, Sharjah, Abudhabi, Ajman, Alain, Fujairah, Ras Al Khaimah, Umm Al Quwain, UAE, Buy cytotec in Dubai +971581248768''''Abortion Pills near me DUBAI | ABU DHABI|UAE. Price of Misoprostol, Cytotec” +971581248768' Dr.DEEM ''BUY ABORTION PILLS MIFEGEST KIT, MISOPROTONE, CYTOTEC PILLS IN DUBAI, ABU DHABI,UAE'' Contact me now via What's App…… abortion Pills Cytotec also available Oman Qatar Doha Saudi Arabia Bahrain Above all, Cytotec Abortion Pills are Available In Dubai / UAE, you will be very happy to do abortion in Dubai we are providing cytotec 200mg abortion pill in Dubai, UAE. Medication abortion offers an alternative to Surgical Abortion for women in the early weeks of pregnancy. We only offer abortion pills from 1 week-6 Months. We then advise you to use surgery if its beyond 6 months. Our Abu Dhabi, Ajman, Al Ain, Dubai, Fujairah, Ras Al Khaimah (RAK), Sharjah, Umm Al Quwain (UAQ) United Arab Emirates Abortion Clinic provides the safest and most advanced techniques for providing non-surgical, medical and surgical abortion methods for early through late second trimester, including the Abortion By Pill Procedure (RU 486, Mifeprex, Mifepristone, early options French Abortion Pill), Tamoxifen, Methotrexate and Cytotec (Misoprostol). The Abu Dhabi, United Arab Emirates Abortion Clinic performs Same Day Abortion Procedure using medications that are taken on the first day of the office visit and will cause the abortion to occur generally within 4 to 6 hours (as early as 30 minutes) for patients who are 3 to 12 weeks pregnant. When Mifepristone and Misoprostol are used, 50% of patients complete in 4 to 6 hours; 75% to 80% in 12 hours; and 90% in 24 hours. We use a regimen that allows for completion without the need for surgery 99% of the time. All advanced second trimester and late term pregnancies at our Tampa clinic (17 to 24 weeks or greater) can be completed within 24 hours or less 99% of the time without the need surgery. The procedure is completed with minimal to no complications. Our Women's Health Center located in Abu Dhabi, United Arab Emirates, uses the latest medications for medical abortions (RU-486, Mifeprex, Mifegyne, Mifepristone, early options French abortion pill), Methotrexate and Cytotec (Misoprostol). The safety standards of our Abu Dhabi, United Arab Emirates Abortion Doctors remain unparalleled. They consistently maintain the lowest complication rates throughout the nation. Our Physicians and staff are always available to answer questions and care for women in one of the most difficult times in their lives. The decision to have an abortion at the Abortion Cl

+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...

?#DUbAI#??##{{(☎️+971_581248768%)**%*]'#abortion pills for sale in dubai@

Effective data discovery is crucial for maintaining compliance and mitigating risks in today's rapidly evolving privacy landscape. However, traditional manual approaches often struggle to keep pace with the growing volume and complexity of data. Join us for an insightful webinar where industry leaders from TrustArc and Privya will share their expertise on leveraging AI-powered solutions to revolutionize data discovery. You'll learn how to: - Effortlessly maintain a comprehensive, up-to-date data inventory - Harness code scanning insights to gain complete visibility into data flows leveraging the advantages of code scanning over DB scanning - Simplify compliance by leveraging Privya's integration with TrustArc - Implement proven strategies to mitigate third-party risks Our panel of experts will discuss real-world case studies and share practical strategies for overcoming common data discovery challenges. They'll also explore the latest trends and innovations in AI-driven data management, and how these technologies can help organizations stay ahead of the curve in an ever-changing privacy landscape.

TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery

TrustArc

Manulife - Insurer Transformation Award 2024

The Digital Insurer

Webinar Recording: https://www.panagenda.com/webinars/why-teams-call-analytics-is-critical-to-your-entire-business Nothing is as frustrating and noticeable as being in an important call and being unable to see or hear the other person. Not surprising then, that issues with Teams calls are among the most common problems users call their helpdesk for. Having in depth insight into everything relevant going on at the user’s device, local network, ISP and Microsoft itself during the call is crucial for good Microsoft Teams Call quality support. To ensure a quick and adequate solution and to ensure your users get the most out of their Microsoft 365. But did you know that ‘bad calls’ are also an excellent indicator of other problems arising? Precisely because it is so noticeable!? Like the canary in the mine, bad calls can be early indicators of problems. Problems that might otherwise not have been noticed for a while but can have a big impact on productivity and satisfaction. Join this session by Christoph Adler to learn how true Microsoft Teams call quality analytics helped other organizations troubleshoot bad calls and identify and fix problems that impacted Teams calls or the use of Microsoft365 in general. See what it can do to keep your users happy and productive! In this session we will cover - Why CQD data alone is not enough to troubleshoot call problems - The importance of attributing call problems to the right call participant - What call quality analytics can do to help you quickly find, fix-, and prevent problems - Why having retrospective detailed insights matters - Real life examples of how others have used Microsoft Teams call quality monitoring to problem shoot problems with their ISP, network, device health and more.

Why Teams call analytics are critical to your entire business

panagenda

Artificial Intelligence Chap.5 : Uncertainty

Khushali Kathiriya

Keynote 2: APIs in 2030: The Risk of Technological Sleepwalk Paolo Malinverno, Growth Advisor - The Business of Technology Apidays New York 2024: The API Economy in the AI Era (April 30 & May 1, 2024) ------ 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/

Apidays New York 2024 - APIs in 2030: The Risk of Technological Sleepwalk by ...

apidays

Tracing the root cause of a performance issue requires a lot of patience, experience, and focus. It’s so hard that we sometimes attempt to guess by trying out tentative fixes, but that usually results in frustration, messy code, and a considerable waste of time and money. This talk explains how to correctly zoom in on a performance bottleneck using three levels of profiling: distributed tracing, metrics, and method profiling. After we learn to read the JVM profiler output as a flame graph, we explore a series of bottlenecks typical for backend systems, like connection/thread pool starvation, invisible aspects, blocking code, hot CPU methods, lock contention, and Virtual Thread pinning, and we learn to trace them even if they occur in library code you are not familiar with. Attend this talk and prepare for the performance issues that will eventually hit any successful system. About authorWith two decades of experience, Victor is a Java Champion working as a trainer for top companies in Europe. Five thousands developers in 120 companies attended his workshops, so he gets to debate every week the challenges that various projects struggle with. In return, Victor summarizes key points from these workshops in conference talks and online meetups for the European Software Crafters, the world’s largest developer community around architecture, refactoring, and testing. Discover how Victor can help you on victorrentea.ro : company training catalog, consultancy and YouTube playlists.

Finding Java's Hidden Performance Traps @ DevoxxUK 2024

Victor Rentea

EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER

MadyBayot

Following the popularity of “Cloud Revolution: Exploring the New Wave of Serverless Spatial Data,” we’re thrilled to announce this much-anticipated encore webinar. In this sequel, we’ll dive deeper into the Cloud-Native realm by uncovering practical applications and FME support for these new formats, including COGs, COPC, FlatGeoBuf, GeoParquet, STAC, and ZARR. Building on the foundation laid by industry leaders Michelle Roby of Radiant Earth and Chris Holmes of Planet in the first webinar, this second part offers an in-depth look at the real-world application and behind-the-scenes dynamics of these cutting-edge formats. We will spotlight specific use-cases and workflows, showcasing their efficiency and relevance in practical scenarios. Discover the vast possibilities each format holds, highlighted through detailed discussions and demonstrations. Our expert speakers will dissect the key aspects and provide critical takeaways for effective use, ensuring attendees leave with a thorough understanding of how to apply these formats in their own projects. Elevate your understanding of how FME supports these cutting-edge technologies, enhancing your ability to manage, share, and analyze spatial data. Whether you’re building on knowledge from our initial session or are new to the serverless spatial data landscape, this webinar is your gateway to mastering cloud-native formats in your workflows.

Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME

Safe Software

GitHub as a Landing Page

1. GitHub is your Documentation Landing Page Lorna Mitchell, Nexmo

2. Landing Pages The homepage of your documentation A finely crafted experience @lornajane

3. YOU ARE HERE @lornajane

4. Repository Standards https://github.com/Nexmo/repo-standards @lornajane

5. README and GitHub Client Library for PHP ============================ [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-php.svg?branch=mas [![Latest Stable Version](https://poser.pugx.org/nexmo/client/v/stable)]( [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LI [![codecov](https://codecov.io/gh/Nexmo/nexmo-php/branch/master/graph/bad *This library requires a minimum PHP version of 7.1* This is the PHP client library for use Nexmo's API. To use this, you'll n nexmo.com][signup]. @lornajane

6. README and GitHub GitHub renders documentation on the main repo page @lornajane

7. README and GitHub Package managers use README too (e.g. https://packagist.com) @lornajane

8. README Basics • Project title and short explanation of its purpose and scope • Link to documentation or other source link for this project • A bit about Nexmo, including a signup link • ... the middle section depends on your project type ... • How to get help (an issue, an email?) • Links to related resources or further reading @lornajane

9. Repo Types We're working on three distinct types of repository: • Library Code • Tool or Demo App • Supporting Code ... docs-as-code is probably a fourth category @lornajane

10. Library Code README Try these ingredients for a good library README recipe: • Pre-requisites, such as technology requirements, Nexmo account • Installation instructions • Usage instructions • the API reference is not enough by itself • every project needs lots of examples @lornajane

11. Installable Item README For Apps/Demos, use the Library recipe, with extra ingredients • Pre-requisites, such as technology requirements, Nexmo account • Installation instructions • Usage instructions • Deployment instructions • a docker setup • "click to deploy" e.g. Heroku @lornajane

12. Supporting Code README If the code was really just shared to accompany something else: • Link to the thing it is for ... anything else is a bonus :) @lornajane

13. README Furniture Use headings and a table of contents to help users navigate longer READMEs @lornajane

14. Beyond the README @lornajane

15. Repo Metadata Give your project a clear name! • Description is key because it shows in search results • Use the topics to help indicate both technology and features @lornajane

16. Give Permission Every project needs a LICENSE.md without which nobody can use your project anyway Use a standard (OSI) and make sure GitHub has recognised it. @lornajane

17. Welcome Participation Help users to participate • CODE_OF_CONDUCT.md • CONTRIBUTING.md @lornajane

18. GitHub is Your Landing Page Welcome and orient your user, however they reached you. @lornajane

19. Resources and Further Reading • https://github.com/nexmo • https://lornajane.net • https://stoplight.io/blog/open-source-documentation/ • https://github.com/ekalinin/github-markdown-toc.go • https://opensource.org/licenses @lornajane

GitHub as a Landing Page

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (19)

Similar a GitHub as a Landing Page

Similar a GitHub as a Landing Page (20)

Más de Pronovix

Más de Pronovix (20)

Último

Último (20)

GitHub as a Landing Page