Skip to content

Commit 9796de1

Browse files
Fixing documentation typo / format
1 parent 350542d commit 9796de1

File tree

6 files changed

+67
-36
lines changed

6 files changed

+67
-36
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Releases
22

3+
## 3.20.0
4+
5+
### Fixes
6+
7+
- `PropertyFieldDateTimePicker`: Fixed small typos and a sample in the documentation [#628](https://github.com/pnp/sp-dev-fx-property-controls/pull/628)
8+
9+
### Contributors
10+
11+
Special thanks to our contributor: [Guido Zambarda](https://github.com/GuidoZam).
12+
313
## 3.19.0
414

515
## 3.18.0

docs/documentation/docs/about/release-notes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Releases
22

3+
## 3.20.0
4+
5+
### Fixes
6+
7+
- `PropertyFieldDateTimePicker`: Fixed small typos and a sample in the documentation [#628](https://github.com/pnp/sp-dev-fx-property-controls/pull/628)
8+
9+
### Contributors
10+
11+
Special thanks to our contributor: [Guido Zambarda](https://github.com/GuidoZam).
12+
313
## 3.19.0
414

515
## 3.18.0

docs/documentation/docs/guides/contributing.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,23 @@ Typos are embarrassing! Most PR's that fix typos will be accepted immediately. I
2727
Before contributing:
2828

2929
- ensure that the **dev** branch on your fork is in sync with the original **sp-dev-fx-property-controls** repository
30-
```sh
31-
# assuming you are in the folder of your locally cloned fork....
32-
git checkout dev
3330

34-
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
35-
git fetch upstream
31+
```bash
32+
# assuming you are in the folder of your locally cloned fork....
33+
git checkout dev
3634

37-
# update your local dev to be a mirror of what's in the main repo
38-
git pull --rebase upstream dev
39-
```
35+
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
36+
git fetch upstream
37+
38+
# update your local dev to be a mirror of what's in the main repo
39+
git pull --rebase upstream dev
40+
```
4041

4142
- create a feature branch for your change. If you'll get stuck on an issue or merging your PR will take a while, this will allow you to have a clean dev branch that you can use for contributing other changes
42-
```sh
43-
git checkout -b my-contribution
44-
```
43+
44+
```bash
45+
git checkout -b my-contribution
46+
```
4547

4648
## DO's & DON'Ts
4749

docs/documentation/docs/guides/mpa.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,29 @@ The shortest way to prepare your local copy of the project for development and t
44

55
## Install prerequisites
66

7-
Before you start contributing to this project, you will need Node.js. This project has been tested with the 10.x version of Node.js and the version of NPM that comes with it. You can use [Node Version Manager](https://github.com/nvm-sh/nvm) to switch between different versions of Node.js.
7+
Before you start contributing to this project, you will need Node.js. This project (current version 3.x) has been tested with the 18.x version of Node.js and the version of NPM that comes with it. You can use [Node Version Manager](https://github.com/nvm-sh/nvm) or [Node Version Switcher](https://github.com/jasongin/nvs) to switch between different versions of Node.js.
88

99
## Get the local version of the project
1010

1111
- fork this repository
1212
- clone your fork
13-
- in the command line:
13+
- in the command line, run the following commands:
1414
- run `npm install` to restore dependencies
15-
- run `gulp serve` to serve your project
16-
- Start making your changes
15+
- `npm install -g gulp-cli` in order to run `gulp` commands (run `npm list -g gulp-cli` to check if already installed on your machine or not)
16+
- `gulp serve` to serve your project (or `npm run serve` if you want to use [`spfx-fast-serve`](https://github.com/s-KaiNet/spfx-fast-serve))
17+
- Start making your changes
1718

1819
### Documentation
1920

20-
SharePoint Framework Property Controls uses [MkDocs](http://www.mkdocs.org) to publish documentation pages. See more information about installing MkDocs on your operating system at http://www.mkdocs.org/#installation.
21+
SharePoint Framework Property Controls uses [MkDocs](http://www.mkdocs.org) to publish documentation pages. See more information about installing MkDocs on your operating system at <http://www.mkdocs.org/#installation>.
2122

22-
Also, documentation uses custom MkDocs theme that should be installed as well. See [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/)
23+
Also, documentation uses custom MkDocs theme that should be installed as well. See [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/). Currently, documentation is working with version 3.1.0.
2324

2425
Once you have MkDocs and Material theme installed on your machine, in the command line:
2526

2627
- run `cd ./docs/documentation` to change directory to where the manual pages are stored
2728
- run `mkdocs serve` to start the local web server with MkDocs and view the documentation in the web browser
2829

30+
For documentation update, we suggest you to use IDE extensions to help you for the writing process. For example, if you're using VS Code, you can install [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for words spelling and [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) or [learn-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown) for Markdown syntax.
31+
2932
![](https://telemetry.sharepointpnp.com/sp-dev-fx-property-controls/wiki/mpa)

docs/documentation/docs/guides/submitting-pr.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,31 @@
22

33
We appreciate your initiative and would love to integrate your work with the rest of the project! Here is how you can help us do it as quickly as possible.
44

5-
- check, that your feature branch is up-to-date. If it's not, there is a risk of merge conflicts or other issues that will complicate merging your changes into the main repository. Refer to these resources for more information on syncing your repo:
5+
- Check, that your feature branch is up-to-date. If it's not, there is a risk of merge conflicts or other issues that will complicate merging your changes into the main repository. Refer to these resources for more information on syncing your repo:
66
- [GitHub Help: Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
77
- [AC: Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo](http://www.andrewconnell.com/blog/keep-your-forked-git-repo-updated-with-changes-from-the-original-upstream-repo)
88
- Looking for a quick cheat sheet? Look no further:
99

10-
```sh
11-
# assuming you are in the folder of your locally cloned fork....
12-
git checkout dev
10+
```bash
11+
# assuming you are in the folder of your locally cloned fork....
12+
git checkout dev
1313

14-
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
15-
git fetch upstream
14+
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-property-controls** repo
15+
git fetch upstream
1616

17-
# update your local dev branch to be a mirror of what's in the main repo
18-
git pull --rebase upstream dev
17+
# update your local dev branch to be a mirror of what's in the main repo
18+
git pull --rebase upstream dev
1919

20-
# switch to your branch where you are working, say "issue-xyz"
21-
git checkout issue-xyz
20+
# switch to your branch where you are working, say "issue-xyz"
21+
git checkout issue-xyz
2222

23-
# update your branch to update its fork point to the current tip of dev & put your changes on top of it
24-
git rebase dev
25-
```
26-
- submit PR to the **dev** branch of the main repo. PRs submitted to other branches will be declined
27-
- let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
28-
- ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo
29-
- don't worry about changing the version or adding yourself to the list of contributors in `package.json`. We'll do that for you when merging your changes.
23+
# update your branch to update its fork point to the current tip of dev & put your changes on top of it
24+
git rebase dev
25+
```
26+
27+
- Submit PR to the **dev** branch of the main repo. PRs submitted to other branches will be declined
28+
- Let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
29+
- Ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo
30+
- Don't worry about changing the version or adding yourself to the list of contributors in `package.json`. We'll do that for you when merging your changes.
3031

3132
![](https://telemetry.sharepointpnp.com/sp-dev-fx-property-controls/wiki/SubmitPR)

docs/documentation/mkdocs.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
site_name: '@pnp/spfx-property-controls'
22
nav:
33
- Home: 'index.md'
4+
- 'Beta testing': 'beta.md'
5+
- Guides:
6+
- Overview: 'guides/index.md'
7+
- Contributing: 'guides/contributing.md'
8+
- 'Minimal Path to Awesome': 'guides/mpa.md'
9+
- 'Submitting a PR': 'guides/submitting-pr.md'
10+
- 'Migrate v1 to v2': 'guides/migrate-from-v1.md'
411
- Controls:
512
- PropertyFieldButton: 'controls/PropertyFieldButton.md'
613
- PropertyFieldCodeEditor: 'controls/PropertyFieldCodeEditor.md'
@@ -47,11 +54,9 @@ nav:
4754
- PropertyFieldToggleWithCallout: 'controls/PropertyFieldToggleWithCallout.md'
4855
- Helpers:
4956
- PropertyPaneHelpers: 'helpers/PropertyPaneHelpers.md'
50-
- 'Beta testing': 'beta.md'
5157
- About:
5258
- 'Release notes': 'about/release-notes.md'
5359
- License: 'about/license.md'
54-
- 'Project Guides': 'guides'
5560
theme:
5661
name: 'material'
5762
palette:

0 commit comments

Comments
 (0)