Giter Club home page Giter Club logo

cloudmanager-api-docs's Introduction

Adobe Cloud Manager API Documentation

This projects builds the documentation for the Cloud Manager API using the Adobe I/O Gatsby Theme.

How to develop

Requirements

  • Node 14.x
  • Yarn 1.22.x

Building Locally

For local development, simply use :

$ yarn install
$ yarn dev

Launching a deploy

You can deploy using the GitHub actions deploy workflow see deploy instructions.

Creating a new Guide

Creating a new guide page generally consists of three steps (and one optional step):

  1. Create a new Markdown file under pages/guides/api-usage or pages/guides/getting-started. More likely the former than the latter.
  2. Adding a new DiscoverBlock to the index.md file in one of those directories (the same directory the new guide is in) -- this will automatically cause the guide block to appear on the /guides page in the appropriate section.
  3. Add a new page item to gatsby-config.js -- this will cause the guide to appear in the navigation.
  4. (if appropriate) Add a new DiscoverBlock to pages/index.md -- this will cause the guide to appear on the home page.

If you are running yarn dev the whole time, you should be able to instantly view your changes.

cloudmanager-api-docs's People

Contributors

justinedelson avatar renovate-bot avatar bohnertchris avatar bstopp avatar davidjgonzalez avatar guillaumecarlino avatar timkim avatar dmitrymatio avatar kwin avatar oostanc avatar macdonst avatar icaraps avatar tylerrush avatar adtanase-adobe avatar dependabot[bot] avatar dharinisomani avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.