Skip to content

Commit c1a7a8b

Browse files
committed
docs: add svn description
1 parent 3aa0c96 commit c1a7a8b

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,29 @@ Toggling that option will hide or show the layout on the fronted.
2222
1. Clone this repo to `/wp-content/plugins`.
2323
2. Activate the plugin through the 'Plugins' screen in WordPress.
2424

25+
## Publish the plugin to wordpress.org
26+
27+
To publish the plugin to the official wordpress.org page we will need to use SVN. Read more about about [using subversion with WordPress](https://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/)
28+
29+
SVN and the Plugin Directory are a release repository. Unlike Git, you shouldn’t commit every small change, as doing so can degrade performance. Please only push finished changes to your SVN repository.
30+
31+
SVN uses the wordpress.org account username and password. It might aks for password for you u
32+
33+
0. Dont't forget to update the plugin version in the `acf-hide-layout.php` and in the `readme.txt`.
34+
1. Make sure you have SVN installed.
35+
* To install it with homebrew run `brew install subversion`.
36+
2. Run `./run svn_setup`.
37+
* This will create a new folder `svn` and connect it with plugin SVN repository.
38+
3. When you have made changes to the plugin use `./run svn_update_trunk`.
39+
* This will copy all the plugin folders and files to `svn/trunk` folder (except those in the `svn-exclude-list.txt`).
40+
4. Go into `svn` folder with `cd svn` and use `svn` commands to add, commit/push the changes. Here are few useful commands
41+
* `svn up` Update SVN repository, like `git pull`
42+
* `svn status` See status of files, e.g. which are added (A), modified(M) or not added(?)
43+
* `svn add trunk/*` Adds all files in the trunk folder
44+
* `svn ci -m 'feat: add something new'` Commits and pushes the changes
45+
46+
Read more about ["Tagging" New Versions](https://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/#tagging-new-versions)
47+
2548
## Maintainers
2649
This project is maintained by [bleech](https://github.com/bleech).
2750

readme.txt

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ Easily hide the layout of the flexible content on the frontend but still keep it
1212

1313
== Description ==
1414

15-
Sometimes you may need to hide/remove a flexible content layout from showing on the frontend of the website,
16-
but you would still like to keep it in the backend in case you need to re-enable that layout again in the future.
17-
Of course you can always just remove the layout, but if it’s a complex group of fields with a lot of data,
18-
re-creating it later would be a pain. And here the **ACF Hide Layout** plugin comes into play. It adds a small button
19-
with an "eye" icon to easily disable/enable flexible layout content without removing it.
15+
Sometimes you may need to hide/remove a flexible content layout from showing on the frontend of the website, but you would still like to keep it in the backend in case you need to re-enable that layout again in the future.
16+
17+
Of course you can always just remove the layout, but if it’s a complex group of fields with a lot of data, re-creating it later would be a pain. And here the **ACF Hide Layout** plugin comes into play. It adds a small button with an "eye" icon to easily disable/enable flexible layout content without removing it.
2018

2119
== Frequently Asked Questions ==
2220

@@ -25,6 +23,12 @@ with an "eye" icon to easily disable/enable flexible layout content without remo
2523
Next to the flexible content options "Add Layout" and "Remove Layout" is a new option "Hide / Show Layout".
2624
Toggling that option will hide or show the layout on the fronted.
2725

26+
== Screenshots ==
27+
28+
1. Content visible on the frontend
29+
2. Option to hide the layout
30+
3. Hidden content on the frontend
31+
2832
== Requirements ==
2933

3034
* [WordPress](https://wordpress.org/) >= 4.7

0 commit comments

Comments
 (0)