Below is a list of projects that are put forward for technical writing collaboration in this year’s Season of Docs.
As of a reminder of who is involved:
- Chloé Bringmann, @cbringmann (Primary Administrator)
- Andrea Middleton, @andreamiddleton (Backup Administrator)
- Jon Ang, @kenshino (Docs Team/Mentor Support)
- Adam Silverstein, @adamsilverstein (Support from Google)
- Maedah Batool, @maedahbatool (Mentor)
- Milana Cap, @milana_cap (Mentor)
- Estela Rueda, @estelaris (Mentor)
- Ahmad Awais, @mrahmadawais (Mentor)
- Usman Kahlid, @usmankhalid (Mentor)
- John Zenith, @zenithcity (Mentor)
- Tim O’Haver, @timohaver (Mentor)
- Alain Schlesser, @schlessera (Mentor)
- Marcio Zebedeu, @marcio-zebedeu (Mentor)
- Felipe Elia, @felipeelia (Mentor)
- M Asif Rahman, @asif2bd (Mentor)
- MakeWebBetter, @makewebbetter (Mentor)
- Shubham Nigam, @iamshubhamnigam (Mentor)
Project name: A full and renewed set of documentation style guide
Description: We’ve written some style guides along the way but many of those applied to specific handbooks or projects we worked on.
That said, there is not a unified style guide nor is it actually complete.
We propose developing a new style guide while fixing up older ones or simply adopt a great existing one with compatible licenses.
Project Name: Most Popular Security Attacks
Description: There are plenty of security breaches issues reported. We plan to create documentation of some of the most common issues with suggested fixes so that users can learn and solve their issues.
- Link to the open source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. project that needs documentation – https://wordpress.org/support/article
- Update existing documentation – https://wordpress.org/support/article/brute-force-attacks/
- We can have documentation with two to three attacks issues, explain what effect they have on websites, how to prevent, and the fastest way to fix and protect your website.
Project name: Tracking Doc Suggestions / Updates
Description: We do not have a unified tracking system for when a doc needs updates. People do it on Meta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. Trac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. (which is really for code changes to WordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/), report them on Slack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/., and sometimes via Twitter. It’s impossible for people to know if a doc is going through updates or is simply outdated. Some projects use Trello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. for short term purposes. Some projects use GitHub GitHub is a website that offers online implementation of git repositories that can can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/.
We really ought to have a unified tracking system so that we can track these requests and the work to fulfill such requests. And we need to create a process to utilize this system properly.
None at the moment. It’s new!
Project Name: WordPress Development Configuration Guide
Description: Code misconfiguration and setup can introduce security bridges and break security endpoints, thereby leaving the door open for malware infections and cryptographic attacks.
Creating a configuration guide or overview for developing in WordPress will be very useful. Some of these exist but are not organized or put together in a single place. For example, the configuration Guide will have several sections as files and directories, debugging, nonces, database, WordPress salt, constants, queries, global vars, htaccess, password, https HTTPS is an acronym for Hyper Text Transfer Protocol Secure. HTTPS is the secure version of HTTP, the protocol over which data is sent between your browser and the website that you are connected to. The 'S' at the end of HTTPS stands for 'Secure'. It means all communications between your browser and the website are encrypted. This is especially helpful for protecting sensitive data like banking information., etc.
Project Name: Curate Existing HelpHub Article To Create Pillar Contents
Description: We are continuously creating more content in HelpHub, but basic questions like “Locally Host WordPress” or “How To Secure WordPress”, are answered with separate CPT and not one article to answer completely or links to existing content. While the current configuration is good for SEO, it is confusing for our users.
- Link to the open source project that needs documentation: https://wordpress.org/support/
- I am proposing ‘Pillar Content” that will be curated collection of existing content that will direct guide users in finding more authenticated information. Like “How To Secure WordPress” will give precise guideline and will link and resources from following contents
Include links to similar documentation in other projects:
Project name: Improve Existing Development Documentation and Handbooks
Description: We have a lot of developer documentation. Core Core is the set of software required to run WordPress. The Core Development Team builds WordPress.’s documentation is mostly automated.
However handbooks that describe how one would create a theme, make a plugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party, use the REST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. or automate things via the CLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. do not receive updated documentation. In turn, this requires that all handbook maintainers know all the changes in each core release to be able to write something useful.
In some cases, the handbooks are updated but don’t provide enough examples for new developers to get started. We would like to close these gaps.
Project Name: Improving article discoverability
Description: During the design process, it was discovered that categories are not used to classify documentation articles and an article may have more than two categories instead of using tags to related articles. This makes it difficult for users to search, as they can click on a category The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. > article, and hit the return button only to find themselves in an entirely different category. Another issue is the titles which in some cases do not properly describe what the article is about.
Project Name: Extending Block Editor
Description: Documentation on developing on top of Block Editor is, depending on the topic, either scarce, outdated, or non-existent. Considering that Block Editor is a significant language leap for WordPress developers, I think the project itself would benefit from having detailed documentation in a form of guides or tutorials, on how to utilize and extend core functionality and what the best practices are.
- Link to the open source project that needs documentation – https://developer.wordpress.org/block-editor/
- Updates to an existing documentation set – https://developer.wordpress.org/block-editor/tutorials/
- Features that need documenting: creating custom blocks (basic webpack setup, what plugins are used and why), using editor’s components in custom blocks, using core blocks in custom blocks, using data stores, using all the hooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same., block settings, plugin sidebars, RichText format types etc. Really, everything.
- Link to similar documentation in other projects – https://www.gatsbyjs.org/tutorial/
Project Name: Write your first WordPress Theme
It is not enough to say that creating a WordPress theme is easy if we do not show it in practice in the documentation. Currently we have a good article on how to start with WordPress, I believe we could do more to make the theme development manual better, as it does not provide a kind of tutorial that really ends with the creation of a functional theme.
- Related Material:
- Link to the open source project that needs documentation: https://wordpress.org/support/article
- Updates to existing documentation:
- It can be divided into stages: Creating a html HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. template, adding simple styles, separating those from html files and finally converting to one of the templates for the WordPress theme