versionpress/docs

VersionPress docs content

Moved

The docs content has been moved to the main repo, see versionpress/versionpress#1218.

docs's Issues

Mention 2.x configuration mechanism on the configuration page

We've changed the configuration page significantly for 3.0 but as we don't maintain historic versions, we should add a note about the old, 2.x style configuration to that page as well.

Document seamless update

Document versionpress/versionpress#906

Update images in documents

Images contained in documents displaying VersionPress "in action" should be replaced. GUI has changed a little bit since old images were taken.

Get rid of NEON mentions, we now use YAML (vp#703)

See versionpress/versionpress#703

Update roadmap after VP 3.0

Update the roadmap to reflect the state after VP 3.0 is released.

• Comment meta?

Can't activate version press

I'm getting file permissions problems, even though I have (as a test) made pretty much everything under html/ writeable by the apache user

Quick summary
array (
'wordpress-version' => '4.5.2',
'versionpress-version' => '3.0.1',
'operating-system' => 'Linux ********************* 3.10.0-327.18.2.el7.x86_64 #1 SMP Thu May 12 11:03:55 UTC 2016 x86_64',
'php-version' => '5.6.22',
'php-sapi' => 'apache2handler',
'git-version' => '2.8.3',
'git-full-path' => '/usr/bin/git
',
)
Git
array (
'git-binary-as-configured' => 'git',
'git-available' => true,
'git-version' => '2.8.3',
'git-binary-as-called-by-vp' => 'git',
'git-full-path' => '/usr/bin/git
',
'versionpress-min-required-version' => '1.9',
'matches-min-required-version' => true,
)
Permissions
array (
'exec-user' => 'apache',
'proc_open-user' => 'apache',
'php-can-write' =>
array (
'ABSPATH' => false,
'WP_CONTENT_DIR' => true,
'sys_temp_dir' => true,
),
'php-can-delete' =>
array (
'ABSPATH' => true,
'WP_CONTENT_DIR' => true,
'sys_temp_dir' => true,
),
'process-can-write' =>
array (
'ABSPATH' => false,
'WP_CONTENT_DIR' => true,
'sys_temp_dir' => true,
),
'php-can-delete-file-created-by-process' =>
array (
'ABSPATH' => true,
'WP_CONTENT_DIR' => true,
'sys_temp_dir' => true,
),
)

Where is ABSPATH defined?

I have restarted the https daemon.

Change config.yaml and front matter versions from float to string.

Docs site will use SemVer for deciding if article should be accessible to user or not (see versionpress/docs-site#73). SemVer version is in string e.g. 1.2.3-rc1. Versions in docs should be updated to strings.

Document vpconfig.neon -> wp-config.php (#566)

Document versionpress/versionpress#566

Warn about stricter system requirements for multi-environment workflows

Add warning to every /sync/* page.

Document common config (#630)

Document versionpress/versionpress#630

Add description of command `wp vp check-requirements`

Add brief documentation of command, which checks if VersionPress requirements are met on target environment.

Required PHP version 5.6 or 7.0 (#726)

Document versionpress/versionpress#726

Review system requirements

It's now quite an old document, review it and possibly suggest newer versions of PHP etc.

HTTP -> HTTPS

We've moved all our web assets to HTTPS in April, let's update the links.

Update links to HTTPS

We're switching all the websites to HTTPS today (6 Apr 2016), all the links should be updated accordingly.

Document commit searching (#586)

Document versionpress/versionpress#586.

EAP -> Early Access

We're discontinuing EAP (versionpress/versionpress#786), the docs should be updated accordingly.

Document configurable entity ignoring (#511)

Document versionpress/versionpress#511. Things worth mentioning:

• Format used for ignoring
• What is ignored by default
• What cannot be ignored using the current format
• Link to query language - should be a separate docs issue

Set linebreaks to LF

Document files contain linebrakes in CR+LF format. Please change it to LF.

Document permission issues on IIS

IIS sometimes suffers from permission issues, document them. See also versionpress/versionpress#522.

Add <p> tags

Some documents contain info warning note without p tags. New parser of markdown files does not add p if paragraph is inside html element.

Document plugins / themes installed via Composer (#1037)

Page feature-focus/composer should contain some info about this feature. Also, there is a link from code to this page.

Transfer release notes to the main repo

The release notes would be better in the main repo using the GitHub's Releases feature. Transfer it there.

Also, retrospectively add ZIP files of the releases.

Document how we handle frequent DB writes (#512)

Document versionpress/versionpress#512 (PR versionpress/versionpress#627).

Rename config.yaml to .yml and remove three hyphens

Tiny change but YAML files usually use the .yml extension (Please Use .yml for YAML) and don't need to start with three hyphens (---) if they contain just single documents.

Update docs to point to GitHub repo

Review all the docs and point to our main GitHub repo where appropriate.

Document custom structure (#565)

Document versionpress/versionpress#565. There are only some supported scenarios of customising project structure.

• Document supported scenarios
• Document public "VP_" constants, e.g., VP_PROJECT_ROOT, VP_VPDB_DIR.

Document post tracking flow

Take it from versionpress/versionpress#612 (comment).

Update documentation of `restore-site` command

In versionpress/versionpress#584 we removed most of configuration parameters and made siteurl mandatory.

Document configurable location of VPDB directory

We should write some docs for versionpress/versionpress#656