Skip to content
This repository was archived by the owner on Feb 10, 2024. It is now read-only.

Commit 85d7505

Browse files
skttlskttl
committed
chore: adds docs+readmes
1 parent 3a72da2 commit 85d7505

16 files changed

+837
-8
lines changed

‎CHANGELOG.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## UNRELEASED
9+
- Updated to Umbraco 9.0.0
10+
- DocTypeGridEditorSurfaceController replaced by DocTypeGridEditorViewComponent
11+
- Finding moved cheese
12+
- Changed DocTypeGridEditorHelper from a static class to being registered in the container for DI.
13+
- Adds default DocTypeGridEditorViewComponent used for all not hijacked rendering.
14+
15+
## 1.2.7 - 2020-03-28
16+
- Fix: Null error when validation fails
17+
- Fix: Resetting save button when validation fails
18+
19+
## 1.2.6 - 2020-12-07
20+
- Fix: Error saving temp blueprint
21+
- Fix: issue when previewing linked content items
22+
23+
## [1.2.5] - 2020-11-01
24+
- Resetting saveButtonState when validation contains errors #221
25+
- Handle null value when deserializing grid value in DataValueReference 50ba85aaeeb66ed305248d303d568e4698943094
26+
27+
## [1.2.4] - 2020-09-09
28+
- Clear earlier serverside validation errors #217
29+
- Null Pointer Exception on save when no grid layout selected #211
30+
- Unsaved Changes dialog fires when hitting submit on grid editors #205
31+
32+
## [1.2.3] - 2020-06-05
33+
- #199 2 Element Types in same Nested Content freeze the Add content button in the grid layout
34+
- #202 Contenttemplates are left behind when validation is not succesfull
35+
- #203 "activeVariant.language is null" - thanks @Matthew-Wise
36+
37+
## [1.2.2] - 2020-05-14
38+
- Infinite loading when doc type has a content template #192 - thanks for reporting @OlePc
39+
- GetPreviewMarkup null reference error when getting cultures #195 - thanks for reporting *and fixing* @Matthew-Wise
40+
41+
## [1.2.1] - 2020-04-27
42+
- Disables notifications after each edit #190
43+
- Moves intrusive styling in previews to css file #188
44+
- Fixes JS error when no doctypes selected in multitype #186
45+
- Fixes bug where wrong editor gets removed when cancelling #185
46+
- Now works with custom backoffice URL #138
47+
48+
## [1.2.0] - 2020-04-12
49+
- #173 Added ValueProcessors and added processor for Umbraco.Tags
50+
- #176 Enables client side validation
51+
- #182 Enables media tracking in 8.6
52+
53+
## [1.1.0] - 2019-12-11
54+
- Changed the size attribute on grid editors to enable the new medium size in Umbraco 8.4 #167
55+
- Adds class to the preview container, so it's easier to target with custom css 47c8f5d
56+
- Check for culture variation when picking content types #154 f5453db c19a93f
57+
- Added implementation of Alias property #160
58+
59+
## [1.0.0] - 2019-08-20
60+
- Uses Infinite Editing (editorService) for editing DTGE content, instead of overlays.
61+
- Adds option to set dialog (infinite editor) size from grid editor config.
62+
- Adds Content Template aka Blueprints support for DTGE items.
63+
- Updates default placeholder for DTGEs without previews enabled.
64+
- Developers Guide updated
65+
- New minimum Umbraco version requirement: 8.1.0 - Doc Type Grid Editor will not work in lower versions!
66+
67+
[unreleased]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.5...HEAD
68+
[1.2.5]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.4...1.2.5
69+
[1.2.4]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.3...1.2.4
70+
[1.2.3]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.2...1.2.3
71+
[1.2.2]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.1...1.2.2
72+
[1.2.1]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.2.0...1.2.1
73+
[1.2.0]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.1.0...1.2.0
74+
[1.1.0]: https://github.com/skttl/umbraco-doc-type-grid-editor/compare/1.0.0...1.1.0
75+
[1.0.0]: https://github.com/skttl/umbraco-doc-type-grid-editor/releases/tag/1.0.0

‎CONTRIBUTING.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Contributing to this project
2+
3+
Please take a moment to review this document in order to make the contribution
4+
process easy and effective for everyone involved.
5+
6+
Following these guidelines helps to communicate that you respect the time of
7+
the developers managing and developing this open source project. In return,
8+
they should reciprocate that respect in addressing your issue or assessing
9+
patches and features.
10+
11+
12+
## Using the issue tracker
13+
14+
The issue tracker is the preferred channel for [bug reports](#bugs),
15+
[features requests](#features) and [submitting pull
16+
requests](#pull-requests), but please respect the following restrictions:
17+
18+
* Please **do not** use the issue tracker for personal support requests (use
19+
[Our Umbraco](https://our.umbraco.org/projects/backoffice-extensions/doc-type-grid-editor/doc-type-grid-editor-feedback/) or Twitter).
20+
21+
* Please **do not** derail or troll issues. Keep the discussion on topic and
22+
respect the opinions of others.
23+
24+
25+
<a name="bugs"></a>
26+
## Bug reports
27+
28+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
29+
Good bug reports are extremely helpful - thank you!
30+
31+
Guidelines for bug reports:
32+
33+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
34+
reported.
35+
36+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
37+
latest `master` or development branch in the repository.
38+
39+
3. **Isolate the problem** &mdash; create a reduced test case and a live example.
40+
41+
A good bug report shouldn't leave others needing to chase you up for more
42+
information. Please try to be as detailed as possible in your report. What is
43+
your environment? What steps will reproduce the issue? What browser(s) and OS
44+
experience the problem? What would you expect to be the outcome? All these
45+
details will help people to fix any potential bugs.
46+
47+
Example:
48+
49+
> Short and descriptive example bug report title
50+
>
51+
> A summary of the issue and the browser/OS environment in which it occurs. If
52+
> suitable, include the steps required to reproduce the bug.
53+
>
54+
> 1. This is the first step
55+
> 2. This is the second step
56+
> 3. Further steps, etc.
57+
>
58+
> `<url>` - a link to the reduced test case
59+
>
60+
> Any other information you want to share that is relevant to the issue being
61+
> reported. This might include the lines of code that you have identified as
62+
> causing the bug, and potential solutions (and your opinions on their
63+
> merits).
64+
65+
66+
<a name="features"></a>
67+
## Feature requests
68+
69+
Feature requests are welcome. But take a moment to find out whether your idea
70+
fits with the scope and aims of the project. It's up to *you* to make a strong
71+
case to convince the project's developers of the merits of this feature. Please
72+
provide as much detail and context as possible.
73+
74+
75+
<a name="pull-requests"></a>
76+
## Pull requests
77+
78+
Good pull requests - patches, improvements, new features - are a fantastic
79+
help. They should remain focused in scope and avoid containing unrelated
80+
commits.
81+
82+
**Please ask first** before embarking on any significant pull request (e.g.
83+
implementing features, refactoring code, porting to a different language),
84+
otherwise you risk spending a lot of time working on something that the
85+
project's developers might not want to merge into the project.
86+
87+
Please adhere to the coding conventions used throughout a project (indentation,
88+
accurate comments, etc.) and any other requirements (such as test coverage).
89+
90+
Follow this process if you'd like your work considered for inclusion in the
91+
project:
92+
93+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
94+
and configure the remotes:
95+
96+
```bash
97+
# Clone your fork of the repo into the current directory
98+
git clone https://github.com/<your-username>/<repo-name>
99+
# Navigate to the newly cloned directory
100+
cd <repo-name>
101+
# Assign the original repo to a remote called "upstream"
102+
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
103+
```
104+
105+
2. If you cloned a while ago, get the latest changes from upstream:
106+
107+
```bash
108+
git checkout develop
109+
git pull upstream develop
110+
```
111+
112+
3. Create a new topic branch (off the main project `develop` branch) to
113+
contain your feature, change, or fix:
114+
115+
```bash
116+
git checkout -b <topic-branch-name>
117+
```
118+
119+
4. Commit your changes in logical chunks. Please adhere to these [git commit
120+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
121+
or your code is unlikely be merged into the main project. Use Git's
122+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
123+
feature to tidy up your commits before making them public.
124+
125+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
126+
127+
```bash
128+
git pull [--rebase] upstream develop
129+
```
130+
131+
6. Push your topic branch up to your fork:
132+
133+
```bash
134+
git push origin <topic-branch-name>
135+
```
136+
137+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
138+
with a clear title and description.
139+
140+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
141+
license your work under the same license as that used by the project.

‎LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright &copy; 2019 Søren Kottal, Our Umbraco and other contributors
2+
Copyright &copy; 2017 UMCO, Our Umbraco and other contributors
3+
Copyright &copy; 2014 Umbrella Inc
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9+
of the Software, and to permit persons to whom the Software is furnished to do
10+
so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 94 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,97 @@
1-
# Doc Type Grid Editor for Umbraco 9 (net core)
1+
# Doc Type Grid Editor
22

3-
Hi there Umbraco Grid fans - this is my WIP of the port of Doc Type Grid Editor for the upcoming Umbraco 9.
3+
[![NuGet release](https://img.shields.io/nuget/v/Our.Umbraco.DocTypeGridEditor.svg)](https://www.nuget.org/packages/Our.Umbraco.DocTypeGridEditor)
4+
[![Our Umbraco project page](https://img.shields.io/badge/our-umbraco-orange.svg)](https://our.umbraco.org/projects/backoffice-extensions/doc-type-grid-editor)
45

5-
First a few disclaimers
6-
- I have never worked with .net core before. Don't expect me to be able to fix or answer everything.
7-
- My goal is to have a comparable version of DTGE ready for v9
8-
- I am probably going to need (a lot of) help fixing issues with this
9-
- DTGE is in my opinion feature complete - I don't want to add any new features
106

11-
Check out the issue tracker for known issues. All issues need help, so if you want to see DTGE happen for Umbraco 9, then this is where you are needed!
7+
A grid editor for Umbraco that allows you to use Doc Types as a blue print for grid-cell data.
8+
9+
10+
## Getting Started
11+
12+
### Installation
13+
14+
> *Note:* Doc Type Grid Editor has been developed against Umbraco since v7 supports different versions of Umbraco:
15+
16+
17+
DTGE is compatible with the following Umbraco versions:
18+
Umbraco 7.1-7.5: DocTypeGridEditor 0.5.0
19+
Umbraco 7.6-7.x: DocTypeGridEditor 0.6.0
20+
Umbraco 8.1-8.5: DocTypeGridEditor 1.1.0
21+
Umbraco 8.5-8.x: DocTypeGridEditor 1.2.7
22+
Umbraco 9.0-9.x: DocTypeGridEditor 2.0.0
23+
24+
Doc Type Grid Editor can be installed from either Our Umbraco package repository, or NuGet. From version 2.0.0 only NuGet can be used to install the package.
25+
26+
#### Our Umbraco package repository
27+
28+
To install from Our Umbraco, please download the package from:
29+
30+
> [https://our.umbraco.org/projects/backoffice-extensions/doc-type-grid-editor](https://our.umbraco.org/projects/backoffice-extensions/doc-type-grid-editor)
31+
32+
#### NuGet package repository
33+
34+
To [install from NuGet](https://www.nuget.org/packages/Our.Umbraco.DocTypeGridEditor), you can run the following command from within Visual Studio:
35+
36+
PM> Install-Package Our.Umbraco.DocTypeGridEditor
37+
38+
---
39+
40+
## Developers Guide
41+
42+
For details on how to use the Doc Type Grid Editor package, please refer to our documentation.
43+
44+
* [Doc Type Grid Editor - Developers Guide, v1.2.x](docs/developers-guide-v1.md)
45+
* [Doc Type Grid Editor - Developers Guide, v2.x.x](docs/developers-guide-v2.md)
46+
47+
---
48+
49+
## Known Issues
50+
51+
Please be aware that not all property-editors will work within Doc Type Grid Editor. The following Umbraco core property-editors are known to have compatibility issues:
52+
53+
* Image Cropper
54+
* Macro Container
55+
* Tags
56+
* Upload
57+
58+
---
59+
60+
## Contributing to this project
61+
62+
Anyone and everyone is welcome to contribute. Please take a moment to review the [guidelines for contributing](CONTRIBUTING.md).
63+
64+
* [Bug reports](CONTRIBUTING.md#bugs)
65+
* [Feature requests](CONTRIBUTING.md#features)
66+
* [Pull requests](CONTRIBUTING.md#pull-requests)
67+
68+
69+
## Contact
70+
71+
Have a question?
72+
73+
* [Doc Type Grid Editor Forum](https://our.umbraco.org/projects/backoffice-extensions/doc-type-grid-editor/doc-type-grid-editor-feedback/) on Our Umbraco
74+
* [Raise an issue](https://github.com/skttl/umbraco-doc-type-grid-editor/issues) on GitHub
75+
76+
77+
## Dev Team
78+
79+
* [Søren Kottal](https://github.com/skttl)
80+
81+
### Special thanks
82+
83+
* Thanks to [Matt Brailsford](https://github.com/mattbrailsford) and [Lee Kelleher](https://github.com/leekelleher) for building this great package.
84+
* Thanks to [Jeavon Leopold](https://github.com/Jeavon) for being a rockstar and adding AppVeyor &amp; NuGet support.
85+
* Thanks to [Dave Woestenborghs](https://github.com/dawoe) for helping solve showstopper issues.
86+
* Thanks to [Arnold Visser](https://github.com/ArnoldV) and [Bjarne Fyrstenborg](https://github.com/bjarnef) for help with porting the package to Umbraco 8.
87+
88+
89+
## License
90+
91+
Copyright &copy; 2019 Søren Kottal, Our Umbraco and [other contributors](https://github.com/skttl/umbraco-doc-type-grid-editor/graphs/contributors)
92+
93+
Copyright &copy; 2017 UMCO, Our Umbraco and [other contributors](https://github.com/skttl/umbraco-doc-type-grid-editor/graphs/contributors)
94+
95+
Copyright &copy; 2014 Umbrella Inc
96+
97+
Licensed under the [MIT License](LICENSE.md)

‎docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Doc Type Grid Editor
2+
## Documentation
3+
4+
* [Doc Type Grid Editor - Developers Guide, v1.2.x](developers-guide-v1.md)
5+
* [Doc Type Grid Editor - Developers Guide, v2.x.x](developers-guide-v2.md)

0 commit comments

Comments
 (0)