Skip to content

Commit c076725

Browse files
autumnfjeldautumnfjeld
authored
Update/readme and docs (#78)
* Update readme with enough detail to be public ready * Add get started and license files * Fix filename and add better get started outline * Add link to roadmap issue
1 parent bbd6e31 commit c076725

File tree

3 files changed

+391
-7
lines changed

3 files changed

+391
-7
lines changed

‎GETSTARTED.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
# Get Started
3+
4+
5+
Watch our tutorial video [TODO]
6+
7+
8+
## Quick Start
9+
10+
### Data Model Main Workflow
11+
12+
**Data model creation**
13+
14+
* From the Content Models page, click Add New Model.
15+
* Create the custom post type and custom fields in the Editor.
16+
* When adding blocks that will be bound, add placeholder value in the block content.
17+
* Use the Attribute Bindings UI in the BLock Inspector panel to set up bindings.
18+
* Use the Manage Fields UI to manage all post_meta fields.
19+
* Use the special binding key `post_content` with a Group block to generate a bound rich text area.
20+
* Save the data model.
21+
22+
23+
**Data entry**
24+
25+
* Click on the data model name in the wp-admin side bar.
26+
* Populate a few CPT instances with content values.
27+
28+
**Front-end layout**
29+
30+
* Single post
31+
* You can set up the the single post layout in the CPT template.
32+
* Alternatively you can create a new MyCPTsingle.html template and add block variations from the block inserter.
33+
* Query loop
34+
* Create a custom query loop on a page or template (e.g. the theme’s home template) and add block variations from the block inserter.
35+
36+
### Plugin Export Workflow
37+
38+
* Click Content Models > Export.
39+
* Export the data model plugin.
40+
* Import the data model to a new site (or deactivate the main plugin on the current site and import the new plugin).
41+
* Populate the data model in the custom post typel.
42+

‎LICENSE.md

+257
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,257 @@
1+
# The GNU General Public License, Version 2, June 1991 (GPLv2)
2+
3+
> Copyright (C) 1989, 1991 Free Software Foundation, Inc.
4+
> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
5+
6+
Everyone is permitted to copy and distribute verbatim copies of this license
7+
document, but changing it is not allowed.
8+
9+
## Preamble
10+
11+
The licenses for most software are designed to take away your freedom to share
12+
and change it. By contrast, the GNU General Public License is intended to
13+
guarantee your freedom to share and change free software--to make sure the
14+
software is free for all its users. This General Public License applies to most
15+
of the Free Software Foundation's software and to any other program whose
16+
authors commit to using it. (Some other Free Software Foundation software is
17+
covered by the GNU Library General Public License instead.) You can apply it to
18+
your programs, too.
19+
20+
When we speak of free software, we are referring to freedom, not price. Our
21+
General Public Licenses are designed to make sure that you have the freedom to
22+
distribute copies of free software (and charge for this service if you wish),
23+
that you receive source code or can get it if you want it, that you can change
24+
the software or use pieces of it in new free programs; and that you know you can
25+
do these things.
26+
27+
To protect your rights, we need to make restrictions that forbid anyone to deny
28+
you these rights or to ask you to surrender the rights. These restrictions
29+
translate to certain responsibilities for you if you distribute copies of the
30+
software, or if you modify it.
31+
32+
For example, if you distribute copies of such a program, whether gratis or for a
33+
fee, you must give the recipients all the rights that you have. You must make
34+
sure that they, too, receive or can get the source code. And you must show them
35+
these terms so they know their rights.
36+
37+
We protect your rights with two steps: (1) copyright the software, and (2) offer
38+
you this license which gives you legal permission to copy, distribute and/or
39+
modify the software.
40+
41+
Also, for each author's protection and ours, we want to make certain that
42+
everyone understands that there is no warranty for this free software. If the
43+
software is modified by someone else and passed on, we want its recipients to
44+
know that what they have is not the original, so that any problems introduced by
45+
others will not reflect on the original authors' reputations.
46+
47+
Finally, any free program is threatened constantly by software patents. We wish
48+
to avoid the danger that redistributors of a free program will individually
49+
obtain patent licenses, in effect making the program proprietary. To prevent
50+
this, we have made it clear that any patent must be licensed for everyone's free
51+
use or not licensed at all.
52+
53+
The precise terms and conditions for copying, distribution and modification
54+
follow.
55+
56+
## Terms And Conditions For Copying, Distribution And Modification
57+
58+
**0.** This License applies to any program or other work which contains a notice
59+
placed by the copyright holder saying it may be distributed under the terms of
60+
this General Public License. The "Program", below, refers to any such program or
61+
work, and a "work based on the Program" means either the Program or any
62+
derivative work under copyright law: that is to say, a work containing the
63+
Program or a portion of it, either verbatim or with modifications and/or
64+
translated into another language. (Hereinafter, translation is included without
65+
limitation in the term "modification".) Each licensee is addressed as "you".
66+
67+
Activities other than copying, distribution and modification are not covered by
68+
this License; they are outside its scope. The act of running the Program is not
69+
restricted, and the output from the Program is covered only if its contents
70+
constitute a work based on the Program (independent of having been made by
71+
running the Program). Whether that is true depends on what the Program does.
72+
73+
**1.** You may copy and distribute verbatim copies of the Program's source code
74+
as you receive it, in any medium, provided that you conspicuously and
75+
appropriately publish on each copy an appropriate copyright notice and
76+
disclaimer of warranty; keep intact all the notices that refer to this License
77+
and to the absence of any warranty; and give any other recipients of the Program
78+
a copy of this License along with the Program.
79+
80+
You may charge a fee for the physical act of transferring a copy, and you may at
81+
your option offer warranty protection in exchange for a fee.
82+
83+
**2.** You may modify your copy or copies of the Program or any portion of it,
84+
thus forming a work based on the Program, and copy and distribute such
85+
modifications or work under the terms of Section 1 above, provided that you also
86+
meet all of these conditions:
87+
88+
- **a)** You must cause the modified files to carry prominent notices stating
89+
that you changed the files and the date of any change.
90+
91+
- **b)** You must cause any work that you distribute or publish, that in whole
92+
or in part contains or is derived from the Program or any part thereof, to
93+
be licensed as a whole at no charge to all third parties under the terms of
94+
this License.
95+
96+
- **c)** If the modified program normally reads commands interactively when
97+
run, you must cause it, when started running for such interactive use in the
98+
most ordinary way, to print or display an announcement including an
99+
appropriate copyright notice and a notice that there is no warranty (or
100+
else, saying that you provide a warranty) and that users may redistribute
101+
the program under these conditions, and telling the user how to view a copy
102+
of this License. (Exception: if the Program itself is interactive but does
103+
not normally print such an announcement, your work based on the Program is
104+
not required to print an announcement.)
105+
106+
These requirements apply to the modified work as a whole. If identifiable
107+
sections of that work are not derived from the Program, and can be reasonably
108+
considered independent and separate works in themselves, then this License, and
109+
its terms, do not apply to those sections when you distribute them as separate
110+
works. But when you distribute the same sections as part of a whole which is a
111+
work based on the Program, the distribution of the whole must be on the terms of
112+
this License, whose permissions for other licensees extend to the entire whole,
113+
and thus to each and every part regardless of who wrote it.
114+
115+
Thus, it is not the intent of this section to claim rights or contest your
116+
rights to work written entirely by you; rather, the intent is to exercise the
117+
right to control the distribution of derivative or collective works based on the
118+
Program.
119+
120+
In addition, mere aggregation of another work not based on the Program with the
121+
Program (or with a work based on the Program) on a volume of a storage or
122+
distribution medium does not bring the other work under the scope of this
123+
License.
124+
125+
**3.** You may copy and distribute the Program (or a work based on it, under
126+
Section 2) in object code or executable form under the terms of Sections 1 and 2
127+
above provided that you also do one of the following:
128+
129+
- **a)** Accompany it with the complete corresponding machine-readable source
130+
code, which must be distributed under the terms of Sections 1 and 2 above on
131+
a medium customarily used for software interchange; or,
132+
133+
- **b)** Accompany it with a written offer, valid for at least three years, to
134+
give any third party, for a charge no more than your cost of physically
135+
performing source distribution, a complete machine-readable copy of the
136+
corresponding source code, to be distributed under the terms of Sections 1
137+
and 2 above on a medium customarily used for software interchange; or,
138+
139+
- **c)** Accompany it with the information you received as to the offer to
140+
distribute corresponding source code. (This alternative is allowed only for
141+
noncommercial distribution and only if you received the program in object
142+
code or executable form with such an offer, in accord with Subsection b
143+
above.)
144+
145+
The source code for a work means the preferred form of the work for making
146+
modifications to it. For an executable work, complete source code means all the
147+
source code for all modules it contains, plus any associated interface
148+
definition files, plus the scripts used to control compilation and installation
149+
of the executable. However, as a special exception, the source code distributed
150+
need not include anything that is normally distributed (in either source or
151+
binary form) with the major components (compiler, kernel, and so on) of the
152+
operating system on which the executable runs, unless that component itself
153+
accompanies the executable.
154+
155+
If distribution of executable or object code is made by offering access to copy
156+
from a designated place, then offering equivalent access to copy the source code
157+
from the same place counts as distribution of the source code, even though third
158+
parties are not compelled to copy the source along with the object code.
159+
160+
**4.** You may not copy, modify, sublicense, or distribute the Program except as
161+
expressly provided under this License. Any attempt otherwise to copy, modify,
162+
sublicense or distribute the Program is void, and will automatically terminate
163+
your rights under this License. However, parties who have received copies, or
164+
rights, from you under this License will not have their licenses terminated so
165+
long as such parties remain in full compliance.
166+
167+
**5.** You are not required to accept this License, since you have not signed
168+
it. However, nothing else grants you permission to modify or distribute the
169+
Program or its derivative works. These actions are prohibited by law if you do
170+
not accept this License. Therefore, by modifying or distributing the Program (or
171+
any work based on the Program), you indicate your acceptance of this License to
172+
do so, and all its terms and conditions for copying, distributing or modifying
173+
the Program or works based on it.
174+
175+
**6.** Each time you redistribute the Program (or any work based on the
176+
Program), the recipient automatically receives a license from the original
177+
licensor to copy, distribute or modify the Program subject to these terms and
178+
conditions. You may not impose any further restrictions on the recipients'
179+
exercise of the rights granted herein. You are not responsible for enforcing
180+
compliance by third parties to this License.
181+
182+
**7.** If, as a consequence of a court judgment or allegation of patent
183+
infringement or for any other reason (not limited to patent issues), conditions
184+
are imposed on you (whether by court order, agreement or otherwise) that
185+
contradict the conditions of this License, they do not excuse you from the
186+
conditions of this License. If you cannot distribute so as to satisfy
187+
simultaneously your obligations under this License and any other pertinent
188+
obligations, then as a consequence you may not distribute the Program at all.
189+
For example, if a patent license would not permit royalty-free redistribution of
190+
the Program by all those who receive copies directly or indirectly through you,
191+
then the only way you could satisfy both it and this License would be to refrain
192+
entirely from distribution of the Program.
193+
194+
If any portion of this section is held invalid or unenforceable under any
195+
particular circumstance, the balance of the section is intended to apply and the
196+
section as a whole is intended to apply in other circumstances.
197+
198+
It is not the purpose of this section to induce you to infringe any patents or
199+
other property right claims or to contest validity of any such claims; this
200+
section has the sole purpose of protecting the integrity of the free software
201+
distribution system, which is implemented by public license practices. Many
202+
people have made generous contributions to the wide range of software
203+
distributed through that system in reliance on consistent application of that
204+
system; it is up to the author/donor to decide if he or she is willing to
205+
distribute software through any other system and a licensee cannot impose that
206+
choice.
207+
208+
This section is intended to make thoroughly clear what is believed to be a
209+
consequence of the rest of this License.
210+
211+
**8.** If the distribution and/or use of the Program is restricted in certain
212+
countries either by patents or by copyrighted interfaces, the original copyright
213+
holder who places the Program under this License may add an explicit
214+
geographical distribution limitation excluding those countries, so that
215+
distribution is permitted only in or among countries not thus excluded. In such
216+
case, this License incorporates the limitation as if written in the body of this
217+
License.
218+
219+
**9.** The Free Software Foundation may publish revised and/or new versions of
220+
the General Public License from time to time. Such new versions will be similar
221+
in spirit to the present version, but may differ in detail to address new
222+
problems or concerns.
223+
224+
Each version is given a distinguishing version number. If the Program specifies
225+
a version number of this License which applies to it and "any later version",
226+
you have the option of following the terms and conditions either of that version
227+
or of any later version published by the Free Software Foundation. If the
228+
Program does not specify a version number of this License, you may choose any
229+
version ever published by the Free Software Foundation.
230+
231+
**10.** If you wish to incorporate parts of the Program into other free programs
232+
whose distribution conditions are different, write to the author to ask for
233+
permission. For software which is copyrighted by the Free Software Foundation,
234+
write to the Free Software Foundation; we sometimes make exceptions for this.
235+
Our decision will be guided by the two goals of preserving the free status of
236+
all derivatives of our free software and of promoting the sharing and reuse of
237+
software generally.
238+
239+
## No Warranty
240+
241+
**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
242+
THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
243+
STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
244+
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
245+
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
246+
PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
247+
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
248+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
249+
250+
**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
251+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
252+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
253+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
254+
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
255+
BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
256+
FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
257+
OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

0 commit comments

Comments
 (0)