Contributing to documentation

Slides:

Advertisements

Similar presentations

1 Copyright © 2007 M. E. Kabay. All rights reserved. Using the TRACK CHANGES Features in MS-Word M. E. Kabay, PhD, CISSP-ISSMP CTO & Program Director,

Advertisements

USING WIKISPACES WITH YOUR SILVER BIRCH PROGRAM – LETS HAVE SOME FUN! USING WIKISPACES WITH YOUR SILVER BIRCH PROGRAM LETS HAVE SOME FUN!

Ravi Mathur Updated December 5,  ODTBX uses Git (see the ODTBX Git Tutorial) ODTBXODTBX Git Tutorial ◦ SourceForge account needed (free). SourceForge.

KPLUG and Plone What is Plone, what does KPLUG use it for, why should I care and how can I contribute?

Patterns & practices Symposium 2013 Introducing Git version control into your team Mark

2 President, Susan Hanley LLC Led national Portals, Management Collaboration, and Content practice for Dell Director of Knowledge Management at American.

Version Control with git. Version Control Version control is a system that records changes to a file or set of files over time so that you can recall.

Introduction to Git and Github Joshua imtraum.com.

Programming in Teams And how to manage your code.

RMG Study Group Session I: Git, Sphinx, webRMG Connie Gao 9/20/

NetTech Solutions Working with Web Elements Lesson 6.

Introduction to Git and GitHub

Created by: Maria Abrahms Modified Date: Classification: How to get it done Contributing to OpenStack.

PUBLISHING ONLINE Chapter 2. Overview Blogs and wikis are two Web 2.0 tools that allow users to publish content online Blogs function as online journals.

Source Code Control CSE 3902 Matt Boggus. Source code control options for CSE 3902 Must use source code control that is integrated with Visual Studio.

Version control Using Git Version control, using Git1.

Enabling High-Quality Printing in Web Applications

Source Control Primer Patrick Cozzi University of Pennsylvania CIS Spring 2012.

Version Control. How do you share code? Discussion.

RMG Study Group Basics of Git Nathan Yee 2/23/

Ernst Peter Tamminga Get started with GitHub XCESS expertise center b.v. Netherlands.

SWEN 302: AGILE METHODS Roma Klapaukh & Alex Potanin.

Information Systems and Network Engineering Laboratory II DR. KEN COSH WEEK 1.

IT204 - Web Scripting and Authoring I Introduction to Dreamweaver Unit 6.

Advanced Lesson 5: Advanced Data Management Excel can import data, or bring it in from other sources and file formats. Importing data is useful because.

Git Fundamentals Rochelle Terman 13 January 2014.

Introduction to GitHub Alex Bigazzi Dec. 4, 2013 ITS Lab GitHub Introduction1.

1 GIT NOUN \’GIT\ A DISTRIBUTED REVISION CONTROL AND SOURCE CODE MANAGEMENT (SCM) SYSTEM WITH AN EMPHASIS ON SPEED. INITIALLY DESIGNED AND DEVELOPED BY.

Technical Overview. Project Overview Document Library Document List Index TransmittalsPlanning.

John Lockhart, WebTest Limited STANZ Wellington August 2010 Practical demonstration of FitNesse, FitLibrary and FitLibraryWeb.

Presented by Karen Porter UM School of Business Administration & ImpactOnlineMarketing.com Writing & Publishing Pages & Posts.

GitHub and the MPI Forum: The Short Version December 9, 2015 San Jose, CA.

Collection of works to share with other people It acts as a folder where a person can upload anything from a word document to a YouTube video Wiki allows.

Information Systems and Network Engineering Laboratory I DR. KEN COSH WEEK 1.

Introduction to Git - Chirag Dani. Objectives Basics of Git Understanding different “Mindset of Git” Demo - Git with Visual Studio.

#SummitNow Lessons Learnt From Share Extras Alfresco Summit 2013 Will Abson

© Trustees of Indiana University Released under Creative Commons 3.0 unported license; license terms on last slide. Take Group Projects to the Next Level.

Using Git with collaboration, code review, and code management for open source and private projects. & Using Terminal to create, and push commits to repositories.

1. A new git is initialized as a remote repository JohnRemote repositoryPeter master C0 CodingWhileBlack.com PROPEL CODING

Installing git In Linux: sudo apt-get install git In Windows: download it from run the setuphttp://git-scm.com/download/win.

Source Code Control For CSE 3902 By: Matt Boggus.

Information Systems and Network Engineering Laboratory II

Source Control Systems

I Don’t Git It: A beginner’s guide to git Presented by Mathew Robinson

11 Version control (part 2)

Welcome to WideWorld Importers

GIT AND GITHUB WORKSHOP

Discussion 11 Final Project / Git.

Version control, using Git

Macaualy2 Workshop Berkeley 2017

Core WG Meeting November 16th, 2017.

Let’s Blog Using a Blog as a Communication Tool

Version Control with Git accelerated tutorial for busy academics

The Big Picture

Getting Started and working with Pearson myautomotivelab

Getting Started with Git and Bitbucket

Part 1: Editing and Publishing Files

GitHub A Tool for software collaboration James Skon

Git CS Fall 2018.

Using Github and Github Organization in this Course

Paul S Waters Getting Git.

Git started with git: 2018 edition

Using the TRACK CHANGES Features in MS-Word

GitHub and Git.

Patrick Cozzi University of Pennsylvania CIS Fall 2012

Introduction to Git and Github

Intro to Git & GitHub By Sean O’Mahoney.

The New Tool in Your Kit: Azure Data Studio

Git in Visual Studio.

Presentation transcript:

Contributing to documentation Everybody can help with documentation

Options for documentation Adding documentation as code comments in the source In the Wiki part of GitHub repository itself As a separate repository Creating a “book” using GitBook & GitHub combined By creating samples

Code comments?

Useful tools for Code Comments /// GhostDoc

Wiki part of the repository Wiki has to be enabled for all or for editors only

Wiki

Demo Editing the Wiki online

Excercise Enable Wiki for your GitHub repo Enable editing for All Create your first Wiki page Create a new page for your neighbours Wiki

Visual Editor to help with MD format Wiki pages Simple construct Markdown text format Visual Editor to help with MD format There are AddIns for Visual Studio There are MarkDown editors

Wiki Essentially the Wiki is a repository itself

Wiki pages The Wiki itself is a repository But without pull request features

Demo Cloning the Wiki repo

Use images that are placed in the Wiki repository Wiki pages Use images that are placed in the Wiki repository I add the images in the Wiki main folder OR I create a standard folder in the Wiki repo: images Reference the images in the Wiki repo using relative paths

Demo Images in the Wiki

The Wiki is a repository, can we do more? Managing the Wiki documentation as a “normal” repo Start with a new repo Clone the Wiki Repo Push the Wiki clone into the new “normal” Limit access to the Wiki repo Use the “normal” repo as basis for collaboration Every once and a while, update the Wiki with the data of the normal repo

Gitbook for writing better formatted documentation But wait, there is more Gitbook for writing better formatted documentation www.gitbook.com Integrates with GitHub repo’s Enables publishing Online PDF, ePub, mobi

Demo GitBook for publishing

Thank you

Summary Introduction GitHub workshop Git for documentation maandag 11 juni 2018 Introduction GitHub workshop Git(Hub) for Everyone GitHub for a developer Contributing to Others Managing contributions Contributing to DNNPlatform Git for documentation John Keetman Ernst Peter Tamminga