Skip to content

Update README.md #2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gujralsanyam22 wants to merge 4 commits into from
+10 −4
Closed

Update README.md #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89ee52d
Update README.md
gujralsanyam22 Dec 11, 2020
26ffcdb
Update index.yaml
gujralsanyam22 Dec 11, 2020
cdda055
Merge branch 'main' into main
gujralsanyam22 Dec 11, 2020
b102edd
Update development.md
gujralsanyam22 Dec 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com).

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
GitHub's Docs team works on a pre-production content in a private repo that regularly syncs with this public repo.

In this article:

Expand All @@ -18,7 +18,7 @@ We accept a lot of [different contributions](CONTRIBUTING.md/#types-of-contribut

#### Click **make a contribution** from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on **make a contribution** to navigate directly to that article in the codebase, so that you can begin making your contribution.
As you're using the GitHub Docs, you may find something in an article which you'd like to add to, update, or change. Click on **make a contribution** to navigate directly to that article in the codebase, so that you can begin making your contribution.

<img src="./assets/images/contribution_cta.png" width="400">

Expand All @@ -44,6 +44,7 @@ There are a few more things to know when you're getting started with this repo:

1. If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
2. We do not accept pull requests for translated content - see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
3. also we know that which is better we have to update with that repositries.

## READMEs

Expand All @@ -69,6 +70,7 @@ In addition to the README you're reading right now, this repo includes other REA
## License

The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE).
also check out all documentation and contribute it to github documentation.

All other code in this repository is licensed under a [MIT license](LICENSE-CODE).

Expand Down
6 changes: 5 additions & 1 deletion contributing/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ In a matter of minutes, you will be ready to edit, preview and test your changes
This repo has configuration for debugging with VS Code's built-in Node Debugger.

1. After running the build steps, start the app by running `npm run debug`.

2. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view.

3. In the Debug View, select the **'Node: Nodemon'** configuration, then press F5 or click the green play button. You should see all of your running node processes.

4. Select the node process that's started with the `--inspect` flag.

5. Debugger has now been attached. Enjoy!

For more detailed instructions, please see this [VS Code recipe](https://github.com/Microsoft/vscode-recipes/tree/master/nodemon). You can also learn more about debugging using VS Code [here](https://code.visualstudio.com/docs/editor/debugging).
Expand All @@ -52,7 +56,7 @@ At the `/dev-toc` path, you'll see a list of available versions. Click a version

## Site structure

This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator.
This site it was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator.

Today it's a dynamic Node.js webserver powered by Express, using [middleware](../middleware/README.md) to support proper HTTP redirects, language header detection, and dynamic content generation to support the various flavors of GitHub's product documentation, like GitHub.com and GitHub Enterprise Server.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ links:
kind: dashboard
service: docs-internal
url: https://app.datadoghq.com/dashboard/8uc-x67-tgi/help-docs
- name: Sentry dashboard
- name: Sentry-dashboard
description: Production Sentry dashboard
kind: dashboard
service: docs-internal
Expand Down