Git Product home page Git Product logo

sqldev's Introduction

SQL Server Tutorials Documentation Contributor Guide

You've found the GitHub repository that houses the source for the SQL Server tutorials that are published on http://aka.ms/sqldev.

Contribute to SQL Server tutorials

Firstly, thank you for your interest in contributing to our tutorials. We use Jekyll + Markdown for our documentation. To contribute, simply make a pull request (PR) with changes in the Markdown files or add new Markdown files. We will do our best to review changes within 24 hours.

Repository organization

The content in the repository follows the standard Jekyll folder structure:

\pages

The \pages folder contains the documentation articles formatted as markdown files with an .md extension for each langauge & operating system combination.

_includes

This folder contains reusable content sections to be included in one or more articles. This folder also contains base HTML files that are used across the site.

_sass

This folder contains the CSS files used to style the website

\assets

This folder contains images and js scripts used in the tutorials website.

Use GitHub

For information about how to contribute, how to use the GitHub UI to contribute small changes, and how to fork and clone the repository for more significant contributions, see Authoring in GitHub.

Branches

We recommend that you create local working branches that target a specific scope of change. Each branch should be limited to a single concept/article both to streamline work flow and reduce the possibility of merge conflicts. The following efforts are of the appropriate scope for a new branch:

  • A new article (and associated images)
  • Spelling and grammar edits on an article.
  • Applying a single formatting change across a large set of articles (e.g. new copyright footer).

How to use markdown to format your topic

All the articles in this repository use GitHub flavored markdown. Here's a list of resources.

Article metadata

Article metadata enables certain functionalities, such as author attribution, contributor attribution, breadcrumbs, article descriptions, and SEO optimizations as well as reporting Microsoft uses to evaluate the performance of the content. So, the metadata is important! Here's the guidance for making sure your metadata is done right.

Labels

Automated labels are assigned to pull requests to help us manage the pull request workflow and to help let you know what's going on with your pull request:

  • Contribution License Agreement related
    • cla-not-required: The change is relatively minor and does not require that you sign a CLA.
    • cla-required: The scope of the change is relatively large and requires that you sign a CLA.
    • cla-signed: The contributor signed the CLA, so the pull request can now move forward for review.

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

sqldev's People

Contributors

meet-bhagdev avatar ajlam avatar luisbosquez avatar bureado avatar pinguin999 avatar microsoftopensource avatar badersur avatar msftgits avatar tobiassql avatar

Watchers

James Cloos avatar  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.