Skip to content
This repository was archived by the owner on May 21, 2019. It is now read-only.

Migrate docs from notion #2

Open
wants to merge 21 commits into
base: deploy-to-now
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
63 changes: 0 additions & 63 deletions .vuepress/components/inputText.vue

This file was deleted.

37 changes: 0 additions & 37 deletions .vuepress/components/primaryButton.vue

This file was deleted.

92 changes: 0 additions & 92 deletions .vuepress/components/textareaBox.vue

This file was deleted.

20 changes: 10 additions & 10 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,9 @@ module.exports = {
{
text: 'Guide',
items: [
{ text: 'Windows', link: '/win/guide/' }
]
},
{
text: 'Misc',
items: [
{ text: 'Support', link: 'https://discord.gg/KT3nAR5' },
{ text: 'Changelog', link: 'https://www.notion.so/gitthermal/Release-notes-7d77751a39484413b7ca8564b3f390a9' }
{ text: 'Experimental features', link: '/#experimental-features' },
{ text: 'Contribution', link: '/#contribution' },
{ text: 'FAQ', link: '/#faq' }
]
},
{ text: 'Patron', link: 'https://www.patreon.com/join/mittalyashu?' }
Expand All @@ -43,10 +38,15 @@ module.exports = {
['', 'Introduction'],
['repository', 'Repository'],
['experimental-features', 'Experimental features']
],
'/experimental-features/': [
['file-diff', 'File diff'],
['commit-description', 'Commit description'],
['powered-by', 'Powered by']
]
},
repo: 'http://github.com/gitthermal/thermal/',
docsRepo: 'http://github.com/gitthermal/website/',
repo: 'gitthermal/thermal',
docsRepo: 'gitthermal/docs',
editLinks: true,
editLinkText: 'Help us improve this page!',
lastUpdated: 'Last Updated',
Expand Down
Binary file added .vuepress/public/images/file-diff.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions code-of-conduct/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

Coming soon...
2 changes: 2 additions & 0 deletions contribute/coding-guidelines/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Coding Guidelines

51 changes: 51 additions & 0 deletions contribute/contribution-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contribution Guide

We want to contribute to Thermal to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.

## Not sure how to start contributing?

If you are worried or don’t know where to start, check out the [issues list](http://github.com/gitthermal/thermal/issues/). Issues labeled [help wanted](https://github.com/gitthermal/thermal/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) are good issues to submit a PR for. Issues labeled [good first issue](https://github.com/gitthermal/thermal/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.

You can also read out to Yashu Mittal on Discord `Yashu Mittal#1475`.

## Prerequisites

You'll need the following tools to download and build Code locally:

- Git
- Node.js, version `>=10`
- Yarn

## Build and Run

If you want to understand how Code works or want to debug an issue, you'll want to get the source, build it, and run the tool locally.

### Getting the sources

First, fork the VS Code repository so that you can make a pull request. Then, clone your fork locally:

```sh
git clone https://github.com/<<<your-github-account>>>/thermal.git
cd thermal
yarn
```

### Linting

We use ESLint for linting our sources. You can run eslint across the sources by running the script command `yarn lint`.

## Work Branches

Even if you have push rights on the Microsoft/vscode repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your personal workflow cruft out of sight.

## Pull Requests

To enable us to quickly review and accept your pull requests, always create one pull request per issue and [link the issue in the pull request](https://github.com/blog/957-introducing-issue-mentions). Never merge multiple requests in one unless they have the same root cause. Be sure to follow our [Coding Guidelines](/contribute/coding-guidelines/) and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain [tests](https://github.com/gitthermal/thermal/issues/26) whenever possible.

## Suggestions

We're also interested in your feedback for the future of Code. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.

## Discussion Etiquette

In order to keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.
34 changes: 34 additions & 0 deletions contribute/how-to-contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar: auto
---

# Contribute

Welcome, whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Thermal community.

There are many ways in which you can contribute, beyond writing code, by logging bugs, submitting pull requests, reporting issues, and creating suggestions.

## Reporting Issues

Have you identified a reproducible problem inside the application? Have a feature request? Or a suggestion. We want to hear about it! Read more about [reporting issues](/reporting-issues/) to know more about it.

## Pull requests

Check out our [Contributing Guide](/contribute/contribution-guide/) for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

*Once your pull request is accepted, you will alos get a contributor badge [in discord](https://discord.gg/spyxbGt).*

## Bug hunter

We'll be releasing a canary build soon, which can be downloaded from the [GitHub repository](https://github.com/gitthermal/thermal/).

*You will also get a bug hunter badge [in discord](https://discord.gg/spyxbGt).*

## Join core team

Joining the Thermal core team has it's own fun and few perks.

* Discord `core-team` badge
* Member of Thermal orgnization on GitHub

Learn, [how to join core team?](/contribute/how-to-join-core-team/)
14 changes: 14 additions & 0 deletions contribute/how-to-join-core-team/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to join core team?

We are glad to hear that you are interesting in joining the Thermal core team.

#### Pre-requisites

- **Vue.js**
- 2+ years of experience
- **Open source**
- Already a contributor to the [thermal repository](https://gitlab.com/gitthermal/thermal/)
- **Discord**
- Have a Discord account
- Join thermal discord server
- Wiling to do audio/video call with other core team members
35 changes: 35 additions & 0 deletions contribute/pair-programming/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar: auto
---

# Pair programming

Thermal offers a free pair programming sessions to the community if there's something you'd like to work on together. Get in touch with us if you have a question about contributing or an idea for something to pair on!

The best part of open source is the community, and every community is stronger when it works together. To help build the strongest community possible, Thermal is offering free one-hour pair programming sessions to anyone and everyone in the open source community.

We use Discord ([https://discordapp.com](https://discordapp.com/)) for pair programming. If you’ve never used it, please allow 5 minutes before the meeting to install Discord.

## How community pair programming sessions work?

1. Sign up for any available slot on [the open pairing calendar](https://calendly.com/codecarrot/thermal)
2. You’ll be paired with one of the core team of Thermal
3. Join the video meeting during your time slot
4. Build, learn, or discuss!

### What we expect in pair programming sessions

These sessions are intended for people who would like to work on an issue or pull request related to Thermal.

We also expect the following from pair programming participants:

- If you have a specific goal for the session, that’s helpful, but we can also choose an open issue to tackle if you’re not sure where to start
- All participants are expected to adhere to [Thermal code of conduct](/code-of-conduct/)
- We will ask if it’s okay to record our session; you are *not* required to let us record
- If the session is recorded, we may post the recording on [CodeCarrot YouTube Channel](https://www.youtube.com/channel/UCeUQVjwShjdrEm-tQJW9KpA)

## How to sign up?

We allow booking up to 60 days in advance, and spots tend to fill up fast. If we’re all booked up today, check back tomorrow for the next batch of spots.

[Reserve your spot today](https://calendly.com/codecarrot/thermal) and let’s build something amazing together!
16 changes: 16 additions & 0 deletions contribute/reporting-issue/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Reporting issues

To track issues and feature requests, we use GitHub issue tracker, fill out this form to [submit your issue](https://github.com/gitthermal/thermal/issues/new/choose).

### Before Submitting an Issue

First, please do a search in [open issues](https://github.com/gitthermal/thermal/issues/) to see if the issue or feature request has already been filed.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a `+1` comment.

* 👍 - upvote
* 👎 - downvote

If your issue is a question then please ask the question in [Thermal discord server](https://discord.gg/KT3nAR5).

If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.
Loading