Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 2.3 KB

readme.md

File metadata and controls

39 lines (27 loc) · 2.3 KB
Raw

tcProjWrapper

Often one or more github repos and google docs repositories are used in a single github project. For example: Front end and back end. In addition multiple public or private share for binary documents are also used. This project will serves as a wrapper for both of those conepts as well as being a single repository for documentation.

This project uses mkdocs to provide an simple platform to generate html pages from markdown. It can be hosted anywhere, includes special provisions for ghpages or can be run locally with mkdocs serve

Topcoder Theme

This repository uses a third party theme called cinder. However this theme has been forked and added the topcoder logo . It would be easy enough to include this forked code directly in the tcProjWrapper repo directly, except this project relies heavily on submodule for src so we wanted to include the theme as a submodule too. In addition the submodule could be forked or branched specifly to include a customers logo.

Topcoder Docs

Since this project also contains content, We can include standard docs like bug bash instructions.

Quick Start

  1. Make sure you have python2 and pip2 installed, then run pip2 install mkdocs to install mkdocs
  2. clone the template git clone --recursive git@github.com:topcoderinc/tcProjWrapper.git myproject
  3. cd myproject and run mkdocs serve
  4. You should also edit the mkdocs.yml and edit the sitename. It might be a good idea to remove the .git dir and do a git init to orphan this template(repo) from your new wrapper project.

Changelog

  • 2/13/2017 - ktb updated cinder submodule
  • 2/15/2017 - ktb added setup script in src dir

example setup.sh

git clone --recursive git@github.com:topcoderinc/tcProjWrapper.git drone-series
sed -i.bak s/tcprojWrapper/drone-series/g  mkdocs.yml && rm mkdocs.yml.bak
rm -rf .git*
git init
git add .
git commit -am 'first commit, templated from git@github.com:topcoderinc/tcProjWrapper.git '
mkdir src
git submodule add git@github.com:topcoderinc/dsp-server.git src/dsp-server
git submodule add git@github.com:topcoderinc/dsp-server.git src/dsp-frontend