Git Product home page Git Product logo

ref-docs's Introduction

Azure Reference Documentation

This repo generates and publishes documentation for azure repositories. It's currently in progress...

The project expects the collection of repos to be setup with repo init -u https://github.com/azure/ref-docs.

Getting started

  • git clone https://github.com/azure/ref-docs
  • npm install

Current Commands

  • gulp --tasks # to see all of the tasks
  • gulp build # to build the dist directory
  • etc... read the gulpfile

Publishing steps using docker image (on Windows)

*Note: update default.xml in this repo to reflect correct release tags for each library. Since Documnt DB is still in the private repo their tag shouldbe updated in the gulpfile.js

In PowerShell

  1. create a docker image using the Dockerfile in the root folder.
  2. create a docker container form that image docker create -it <IMAGE_NAME>
  3. docker container ls -a
 CONTAINER ID        IMAGE                                 COMMAND             CREATED             STATUS              PORTS               NAMES
 40243faa06a1        picoded/ubuntu-openjdk-8-jdk   "/bin/bash"         3 months ago        Up 11 minutes                           gifted_pare

*Note: you can create container from the exisitng javadoc docker image docker create -it azureclidev.azurecr.io/azuresdk-javadoc

  1. docker container start 40243faa06a1

then open a cmd

  1. docker attach 40243faa06a1
  2. export PATH=~/bin:$PATH
  3. export JAVA_TOOL_OPTIONS='-Dfile.encoding=UTF8'

in the same cmd window configure env variables:

  1. export GH_TOKEN=... (put here github public access token without any quotes)
  2. git config --global user.email "..." (your github user email e.g. [email protected])
  3. git config --global user.name "..." (your github user id e.g. user)

*Note: github public access token needs to have access to private repo Azure/azure-documentdb-java-pr_

in the same cmd window build and publish java docs:

  1. git clone https://github.com/Azure/ref-docs.git
  2. cd ref-docs
  3. npm install

manual fix requred here due to historical issue in the gh-pages branch. In node_modules/gift/lib/commit.js file change the method to this

   Commit.actor = function(line) {
      var actor, epoch, m, ref1;
      ref1 = /^.+? (.*) (\d+) .*$/.exec(line);
      if(ref1 !== undefined && ref1 !== null && ref1.length > 0) {
        m = ref1[0], actor = ref1[1], epoch = ref1[2];
      } else {
        actor="..."; (your github user. e.g. User Muser <[email protected]>)
        epoch="1518471247"; (magic number)
      }
      return [Actor.from_string(actor), new Date(1000 * +epoch)];
    };
  1. gulp publish

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.