Giter VIP home page Giter VIP logo

documentation-issue-tracker's Introduction

ClassicPress Documentation Issue Tracker

This repository helps track issues for ClassicPress documentation: docs.classicpress.net

documentation-issue-tracker's People

Contributors

viktorix avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation-issue-tracker's Issues

Proposal: Simplify documentation permalink structure

Before I outline the proposed permalink structure, I will note that any URL changes will include redirects. So no old URLs will go to the 404 error page.

Right now we have permalinks such as:

https://docs.classicpress.net/user-guides/using-classicpress/posts-screen/
https://docs.classicpress.net/user-guides/debugging-in-classicpress/
https://docs.classicpress.net/developer-guides/installing-with-composer/
https://docs.classicpress.net/plugin-guidelines/plugin-directory-submission-guidelines/

Code reference permalinks are fine, won't be touched:
https://docs.classicpress.net/reference/functions/__autoload/

Proposed structure:

In addition to a long, complex structure, the CPTs are treated as pages. So the parent dropdown is getting longer and longer.

Proposed change 1: Switch CPTs to post type, no need for parents.

Now, once they don't have parents to be part of the URL we would simply that part.

Proposed change 2: Simplify user guides and developer guides permalinks:
https://docs.classicpress.net/user/posts-screen/
https://docs.classicpress.net/developer/installing-with-composer/

Lastly, right now we have plugin guidelines CPT. But we will be adding themes and snippets soon, which would require their own CPTs.

Proposal change 3: Change plugin guidelines CPT to "guidelines" and keep them with page capabilities, so we can use the parent page for each type of guideline:
https://docs.classicpress.net/guidelines/plugins/directory-submission-guidelines/
https://docs.classicpress.net/guidelines/themes/directory-submission-guidelines/
https://docs.classicpress.net/guidelines/snippets/directory-submission-guidelines/


One additional note. Currently, parent/child relationship is used to automatically display a list of child pages on the parent page. We can either do this manually once changes are made or use the object relationship plugin to create necessary associations for a shortcode to display associated posts.

Feedback and suggestions are welcome.

Restructure permalinks and documentation

Based on the proposal #31, the following changes will be implemented:

Permalink structures:

  • User manual content: /learn/content-title
  • Plugin manual content: /dev/plugins/content-title
  • Theme manual content: /dev/themes/content-title
  • Code reference content: /reference/content-title (kept as is for now)

To structure the content into "manuals," we will use pages and categories as needed.

Updating wp-config.php API

Need a decision on whether to converge the info on https://developer.wordpress.org/apis/wp-config-php/ with https://docs.classicpress.net/user-guides/editing-wp-config-php/ I don't see the need to seperate them since the information is related.

We can reduce the linkages and make editorial work on one page. it makes reading it easy as well.

https://developer.wordpress.org/apis/wp-config-php/ is linked in https://wordpress.org/support/article/editing-wp-config-php/ and https://docs.classicpress.net/user-guides/editing-wp-config-php/ for now.

Originally posted by @bahiirwa in #3 (comment)

"Requires at least" guidelines

https://docs.classicpress.net/plugin-guidelines/plugin-header-requirements/ says (yeah, I have had written that myself in past) that:

Requires at least: The lowest WordPress version that the plugin will work on.
Note: this field only works if the plugin is stored on the WordPress Repository.
Note 2: if set, the version should be no higher than 4.9.15

That is suboptimal, because a plugin can very well require WP above 4.9.15 and also support CP.
The way to do that, is to require WP > 4.9.15 in the header, and if CP is active load whatever other code.
This can be done using something like function_exists( 'classicpress_version' ) && version_compare(classicpress_version(), '1.0.0', '>=');

However, due to the header requirements, one wouldn't be able to do that.

Has the CP Community meanwhile created other types of Header tags (remember that the Requires at least actually ONLY works if the plugin is stored on WP Repo), and/or removed this requirement?

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.