Skip to content

Commit

Permalink
Updating readme and contributor information (MicrosoftDocs#68)
Browse files Browse the repository at this point in the history
Updating to reflect new repo processes for both internal and external contributors
  • Loading branch information
eross-msft authored May 7, 2019
1 parent f07581a commit 831532e
Show file tree
Hide file tree
Showing 30 changed files with 602 additions and 718 deletions.
64 changes: 64 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributing to Windows Server technical documentation

Thank you for your interest in the Windows Server technical documentation! We appreciate your feedback, edits, and additions to our docs.
This page covers the basic steps for editing our technical documentation.

## Sign a CLA

All contributors who are ***not*** a Microsoft employee must [sign a Microsoft Contribution Licensing Agreement (CLA)](https://cla.microsoft.com/) before editing any Microsoft repositories.
If you've already edited within Microsoft repositories in the past, congratulations!
You've already completed this step.

## Editing topics

We've tried to make editing an existing, public file as simple as possible.

### To edit a topic

1. Go to the page on https://docs.microsoft.com/windows-server that you want to update, and then click **Edit**.

![GitHub Web, showing the Edit link](media/contribute-link.png)

2. Sign in to (or sign up for) a GitHub account.

You must have a GitHub account to get to the page that lets you edit a topic.

3. Click the **Pencil** icon (in the red box) to edit the content.

![GitHub Web, showing the Pencil icon in the red box](media/pencil-icon.png)

4. Using Markdown language, make your changes to the topic. For info about how to edit content using Markdown, see:

- **If you're linked to the Microsoft organization in GitHub:** [Windows Server Contributor's Guide](https://github.com/MicrosoftDocs/windowsserverdocs-pr/tree/master/Contributor-guide)

- **If you're external to Microsoft:** [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)

5. Make your suggested change, and then click **Preview Changes** to make sure it looks correct.

![GitHub Web, showing the Preview Changes tab](media/preview-changes.png)

6. When you’re done editing the topic, scroll to the bottom of the page, and then click **Propose file change** to create a fork in your personal GitHub account.

![GitHub Web, showing the Propose file change button](media/propose-file-change.png)

The **Comparing changes** screen appears to see what the changes are between your fork and the original content.

7. On the **Comparing changes** screen, you’ll see if there are any problems with the file you’re checking in.

If there are no problems, you’ll see the message, **Able to merge**.

![GitHub Web, showing the Comparing changes screen](media/compare-changes.png)

8. Click **Create pull request**.

9. Enter a title and description to give the approver the appropriate context about what’s in the request.

10. Scroll to the bottom of the page, making sure that only your changed files are in this pull request. Otherwise, you could overwrite changes from other people.

11. Click **Create pull request** again to actually submit the pull request.

The pull request is sent to the writer of the topic and your edits are reviewed. If your request is accepted, your updates are published.

## Resources

- You can use your favorite text editor to edit Markdown. We recommend [Visual Studio Code](https://code.visualstudio.com/), a free lightweight open source editor from Microsoft.
47 changes: 0 additions & 47 deletions Contributor-guide/Contributor-index.md

This file was deleted.

41 changes: 0 additions & 41 deletions Contributor-guide/Tips-gotchas.md

This file was deleted.

39 changes: 39 additions & 0 deletions Contributor-guide/common-git-bash-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Common Git Bash commands for use with GitHub
description: A list of somme of the most frequently used commands in Git Bash when working with GitHub.
author: eross-msft
ms.author: lizross
ms.date: 05/06/2019
---

# Common Git Bash commands

These are some of the most-used commands in Git Bash, based on when you will use them in your content creation and editing process.

## Master branch-related

You must always use master as your base for any new branch.

| Command | Description |
|---------|-------------|
| `git checkout master` | Switch to master from any other branch |
| `git pull upstream master` | Update your local copy of master from the production repo |

## Branch-related

| Command | Description |
|---------|-------------|
| `git branch` | See your existing branches |
| `git checkout -B <name-of-branch>` | Create a new branch |
| `git checkout <name-of-branch>` | Change to another branch |
| `git status` | Check what’s going on in your branch |
| `git branch -D <name-of-branch>` | Delete an existing branch (making sure you’re not in it) |

## Check-in-related (done as a group, in order)

| Command | Description |
|---------|-------------|
| `git add .` | After you save your work, add it to a branch |
| `git commit -m “public comment, including quotes”` | Commit your changes to your branch |
| `git pull upstream master` | Update your local copy of master from the production repo |
| `git push origin <name-of-branch>` | Push to the remote version of your local branch |
9 changes: 0 additions & 9 deletions Contributor-guide/contributor-guide-official-windows-terms.md

This file was deleted.

43 changes: 0 additions & 43 deletions Contributor-guide/contributor-guide-pr-criteria.md

This file was deleted.

Loading

0 comments on commit 831532e

Please sign in to comment.