Skip to content
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.

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

Closes #11 #26

Merged
merged 5 commits into from
Jul 15, 2022
Merged
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
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## What

- (describe the changes in detail)

## Refs

- (this project accepts pull requests related to open issues)
- (if suggesting a new feature or change, please discuss it in an issue first)
- (if fixing a bug, there should be an issue describing it with steps to reproduce)
- (only fixing a minor bug - broken link, typo - an issue is not needed)
- (please link to the issue here)
38 changes: 38 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: "Bug"
about: "Select this template for reporting issues with the current behaviour and help us improve!"
title: "bug: ..."
labels: "triage, bug"
---

## What

- (describe the current behaviour)
- (describe the expected behaviour)

## Why

- (the reason why the behaviour needs to change)

## Refs

- (optional: include links to other issues, PRs, tickets, etc)

## Context

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser: [e.g. chrome, safari]
- Version: [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser: [e.g. stock browser, safari]
- Version: [e.g. 22]

**Additional context**

<!-- Add any other context about the problem here. -->
1 change: 1 addition & 0 deletions .github/workflows/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
34 changes: 34 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Suggest a new content
about: Suggest a content to our developers portal
title: "content: ..."
labels: "content"
---

**Tutorial title**

<!-- What is the title of your tutorial?-->

**Tutorial description**

<!-- Summarize what the user should be able to accomplish by following tutorial -->

**Tag your tutorial**

<!-- What topics are covered in your tutorial? -->

**Publication**

<!-- If it's been published elsewhere already, let us know -->

**Skill level**

<!-- What level of experience does someone need to be to complete the tutorial? Beginner/Intermediate/Advanced -->

**For tutorials to be hosted on Gnosis: Tutorial Content**

<!-- Please paste the full tutorial in markdown -->

**For tutorials hosted elsewhere: URL to tutorial**

<!-- Please paste the URL to your tutorial -->
19 changes: 19 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/feat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "Feature"
about: "Select this template to suggest an idea to make this a better project"
title: "feat: ..."
labels: "triage, feature"
---

## What

- (describe the current behaviour)
- (describe the desired behaviour)

## Why

- (the reason why the new behaviour is wanted)

## Refs

- (optional: include links to other issues, PRs, tickets, etc)
139 changes: 139 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# Contributing to Gnosis
Thank you for your interest in contributing!

## Run the project

### Prerequisites

[Node.js](https://nodejs.org/en/download/) version 14.13 or higher.

### Installation

```
$ yarn install
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Contents
* Docs are located in the [docs](docs) directory.
* Landing pages are located in the [src/pages](src/pages) directory.
* Images and static files are located in the [static](static) directory.
* The left side-bar of the page is controlled by [sidebars.js](sidebars.js).
* Docusaurus complete documentation can be found [here](https://docusaurus.io/docs).

## Submit an Issue

Start by [searching if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
If a related issue doesn't exist, you can [open a new issue](https://github.com/gnosischain/developers-portal/issues/new/choose) following the instructions of the template accordingly.

Issues are categorized by type:

- Feature
- Content
- Bug

## Creating Pull Requests

For help, see [GitHub Docs: Linking a pull request to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).

- Submit a PR against the `main` branch of the `gnosischain/developers-portal` repo
- Follow the PR template instructions carefuly

## Writing style

We selected a collection of best practices from the industry to make the website easy to read, global, diverse and searchable

- [General Writing Guidelines (by OpenStack)](https://docs.openstack.org/doc-contrib-guide/writing-style/general-writing-guidelines.html)
- [Bias-free communication (by Microsoft)](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)
- [Global communications (by Microsoft)](https://docs.microsoft.com/en-us/style-guide/global-communications/)

## Transfering Gitbook Pages

When transfering documents from the old gitbook, consider the funcionality difference detailed below, and the following:

- Relevance and validity of the content
- ```xdaichain``` was renamed to ```gnosis```
- Open Ethereum was deprecated
- Nifty Wallet deprecation
- Internal and external links

### Images location

#### Gitbook

```
/.gitbook/assets/
```

#### Docusaurus

```
/static/img/
```

### Alerts

#### Gitbook

```
{% hint style="info" %}
Message
{% endhint %}
```

#### Docusaurus

```
:::info
Message
:::
```
Refer to [docusaurus docs](https://docusaurus.io/docs/next/markdown-features/admonitions) for more admonition types.

### Files

#### Gitbook

```
{% file src="somepath/somefile.zip" %}
```

#### Docusaurus

```
{@file: /somefile.zip}
```
Place files in ```/static/files/```

### Youtube Videos

#### Gitbook

```
{% embed url="https://www.youtube.com/watch?v=yPYYKz0u9K0t=10s" %}
```

#### Docusaurus

```
{@youtube: yPYYKz0u9K0t,start=10}
```

### Tabs

Refer to [docusaurus docs](https://docusaurus.io/docs/next/markdown-features/tabs) for details on tabs.
38 changes: 1 addition & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,4 @@ The website is built using [Docusaurus 2](https://docusaurus.io/).

## Contributing

The Developers Portal is an ecosystem tool, we welcome everybody to collaborate and improve it!

### Prerequisites

[Node.js](https://nodejs.org/en/download/) version 14.13 or higher.

### Installation

```
$ yarn install
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Contents
* Docs are located in the [docs](docs) directory.
* Landing pages are located in the [src/pages](src/pages) directory.
* The left side-bar of the page is controlled by [sidebars.js](sidebars.js).
* Docusaurus complete documentation can be found [here](https://docusaurus.io/docs).

### Pull Request (PR)
* TBD

The Developers Portal is an ecosystem tool, we welcome everybody to collaborate and improve it! See the [contributing page](CONTRIBUTING.md) for details.