Skip to content

Commit 00c76fb

Browse files
committed
remove polluted .md files having which are not in docs/
1 parent 13f3d31 commit 00c76fb

File tree

25 files changed

+29
-232
lines changed

25 files changed

+29
-232
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
---
102
name: Bug report
113
about: Create a report to help us improve Volto
124
title: ''
135
labels: '01 type: bug'
146
assignees: ''
15-
167
---
178

189
**Describe the bug**
1910
A clear and concise description of what the bug is.
2011

2112
**To Reproduce**
2213
Steps to reproduce the behavior:
14+
2315
1. Go to '...'
2416
2. Click on '....'
2517
3. Scroll down to '....'
@@ -32,11 +24,12 @@ A clear and concise description of what you expected to happen.
3224
If applicable, add screenshots to help explain your problem.
3325

3426
**Software (please complete the following information):**
35-
- OS: [e.g. iOS]
36-
- Browser [e.g. chrome, safari]
37-
- Volto Version [e.g. 8.5.0]
38-
- Plone Version [e.g. 5.2.2]
39-
- Plone REST API Version [e.g. 7.0.1]
27+
28+
- OS: [e.g. iOS]
29+
- Browser [e.g. chrome, safari]
30+
- Volto Version [e.g. 8.5.0]
31+
- Plone Version [e.g. 5.2.2]
32+
- Plone REST API Version [e.g. 7.0.1]
4033

4134
**Additional context**
4235
Add any other context about the problem here.

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
---
102
name: Feature request
113
about: Suggest an idea for Volto
124
title: ''
135
labels: '04 type: enhancement'
146
assignees: ''
15-
167
---
178

189
**Is your feature request related to a problem? Please describe.**

Diff for: CHANGELOG.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Change Log
102

113
## 14.4.1 (unreleased)
@@ -165,7 +157,7 @@ See https://docs.voltocms.com/upgrade-guide/ for more information about all the
165157
@tiberiuichim
166158
- Added `.storybook` setup in the Volto `app` generator. Volto projects generated from this scafolding are now ready to run Storybook for the project and develop addons (in `src/addons` folder).
167159
- Style checkboxes @nileshgulia1
168-
- Allow loading .less files also from a Volto project's `src` folder. @tiberiuichim
160+
- Allow loading .less files also from a Volto project's `src` folder. @tiberiuichim
169161
- Add catalan translation @bloodbare @sneridagh
170162
- Updated Volto production sites list @giuliaghisini
171163
- Japanese translation updated @terapyon

Diff for: CODE_OF_CONDUCT.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Code of Conduct
102

113
## Anti-Harassment and Anti-Bullying Code of Conduct
@@ -19,4 +11,3 @@ If a participant engages in harassing behavior, representatives of the community
1911
If you are being harassed, notice that someone else is being harassed, or have any other concerns, please act to intercede or ask for help from any member of the Plone Foundation, IRC chat admins, website admins, or organizers/representatives of any physical events put on under the auspices of the Plone Foundation.
2012

2113
Source: https://plone.org/foundation/materials/foundation-resolutions/code-of-conduct (2019-09-29)
22-

Diff for: COMMITLINT.md

+19-29
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,76 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Volto Commit Messages
102

113
Volto uses the (conventional commit specification)[https://www.conventionalcommits.org/en/v1.0.0/#specification] for consistent commit messages.
124

135
All commit messages should have the following form:
146

15-
````
7+
```
168
<type>: <description>
17-
````
9+
```
1810

1911
## Fix
2012

2113
A fix (PATCH in semantic versioning) looks like this:
2214

23-
````
15+
```
2416
fix: correct minor typos in code
25-
````
17+
```
2618

2719
## Feature
2820

2921
A new feature (MINOR in semantic versioning) looks like this:
3022

31-
````
23+
```
3224
feat: add catalan language
33-
````
25+
```
3426

3527
## Breaking Change
3628

3729
Breaking changes can be indicated by either appending a "!" to the type:
3830

39-
````
31+
```
4032
refactor!: drop support for Node 6
41-
````
33+
```
4234

4335
Or adding "BREAKING CHANGE" to the commit message body text:
4436

45-
````
37+
```
4638
refactor!: drop support for Node 6
4739
4840
BREAKING CHANGE: refactor to use JavaScript features not available in Node 6.
49-
````
41+
```
5042

5143
## Available Types
5244

5345
In addition to "fix" and "feat" the following types are allowed:
5446
build:, chore:, ci:, docs:, style:, refactor:, perf:, test:
5547

56-
57-
5848
Install commitlint:
5949

60-
````
50+
```
6151
npm install --save-dev @commitlint/{config-conventional,cli}
62-
````
52+
```
6353

6454
or via yarn:
6555

66-
````
56+
```
6757
yarn add @commitlint/{config-conventional,cli}
68-
````
58+
```
6959

7060
Create a commitlint.config.js file:
7161

72-
````
62+
```
7363
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
74-
````
64+
```
7565

7666
Add husky to package.json:
7767

78-
````
68+
```
7969
{
8070
"husky": {
8171
"hooks": {
8272
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
83-
}
73+
}
8474
}
8575
}
86-
````
76+
```

Diff for: LICENSE.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
MIT License
102

113
Copyright (c) 2017 Plone Foundation

Diff for: README.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Volto
102

113
<img align="right" width="300" alt="Volto png" src="./docs/logos/volto-colorful.png" />

Diff for: ROADMAP.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Roadmap
102

113
## Volto 14 (Plone 6 alpha)

Diff for: SECURITY.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Security Policy
102

113
## Supported Versions
@@ -20,4 +12,3 @@ Volto is currently under very active development. Therefore we only support the
2012
## Reporting a Vulnerability
2113

2214
If you found a possible vulnerability please contact the Plone security team under [email protected].
23-

Diff for: packages/README.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Packages
102

113
This directory is intended to contain packages related to Volto ecosystem.

Diff for: packages/generator-volto/CHANGELOG.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Change Log
102

113
## 5.4.1 (unreleased)

Diff for: packages/generator-volto/DEVELOP.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
## How to develop/test the generator
102

113
### Setup

Diff for: packages/generator-volto/LICENSE.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
MIT License
102

113
Copyright (c) 2018 Plone Foundation

Diff for: packages/generator-volto/README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Yeoman Volto App Generator
102

113
@plone/generator-volto is a Yeoman generator that helps you to set up Volto via command line.
@@ -22,6 +14,7 @@ $ npm install -g @plone/generator-volto
2214
## Usage
2315

2416
### Creating a new Volto project using `npm init`
17+
2518
```
2619
npm init yo @plone/volto
2720
```
@@ -31,6 +24,7 @@ This is the shortcut for using `npm init` command. It uses Yeoman (`yo`) and `@p
3124
Answer the prompt questions to complete the generation process.
3225

3326
### Creating a new Volto project
27+
3428
```
3529
$ yo @plone/volto
3630
```

Diff for: packages/generator-volto/generators/app/templates/README.md

-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
## Documentation
102

113
A training on how to create your own website using Volto is available as part of the Plone training at [https://training.plone.org/5/volto/index.html](https://training.plone.org/5/volto/index.html).
@@ -44,7 +36,6 @@ By default, runs tests related to files changed since the last commit.
4436
Runs the test i18n runner which extracts all the translation strings and
4537
generates the needed files.
4638

47-
4839
### mrs-developer
4940

5041
[mrs-developer](https://github.com/collective/mrs-developer) is a great tool

Diff for: packages/generator-volto/generators/app/templates/src/customizations/README.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Local Customizations
102

113
To override a file in the volto package, add the directory structure and file to

Diff for: packages/scripts/CHANGELOG.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
# Change Log
102

113
## 1.4.1 (unreleased)

Diff for: src/components/manage/Toolbar/PersonalTools.md

-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
7-
---
8-
91
PersonalTools example:
102

113
```js

0 commit comments

Comments
 (0)