GSoD 2023 Project Ideas: Difference between revisions

From Joomla! Documentation

No edit summary
No edit summary
Line 4: Line 4:
{{tip|title=The application for technical writers is going to open soon!}}  
{{tip|title=The application for technical writers is going to open soon!}}  


Welcome to the [[GSoD_2023/en|Joomla Google Season of Docs (GSoD) 2023]] project ideas page.  
Welcome to the [[GSoD_2023|Joomla Google Season of Docs (GSoD) 2023]] project ideas page.  


If you are interested in participating as a technical writer please review the materials on applying that are available at [https://developers.google.com/season-of-docs/docs/tech-writer-application-hints Google].
If you are interested in participating as a technical writer please review the materials on applying that are available at [https://developers.google.com/season-of-docs/docs/tech-writer-application-hints Google].
Line 16: Line 16:
See also the [[JDOC:Joomla_4_Tutorials_Project| Joomla 4 Tutorials Project]]
See also the [[JDOC:Joomla_4_Tutorials_Project| Joomla 4 Tutorials Project]]


== Project 1: Joomla 3.10 to Joomla 4.x Step by Step Migration ==
== Project 1: Joomla! User Guide ==


=== Description===
=== Description===
The migration from Joomla 3.10 to 4.x is considered a mini-migration. This is because most Joomla core extensions will upgrade with a “one-click” upgrade via the Joomla Update component in the backend administrator side of Joomla. <br />
Content follows soon
Step by step instructions to migrate a 3.10 site to Joomla 4.x is needed to help users and encourage them to use the latest version. While there are hundreds of different scenarios, this will need to give the basic procedure to follow.


=== Related materials ===
=== Related materials ===
* Install of Joomla 4:
*  
**[https://github.com/joomla/joomla-cms/tree/4.0-dev GitHub]
**[https://developer.joomla.org/nightly-builds.html Nightly builds]
**[https://launch.joomla.org Launch Joomla]
*[[S:MyLanguage/Category:Migration|Previous Migration Documentation]]


== Project 2: Joomla 4.x Help Screens ==
== Project 2: Joomla! Developer Documentation ==


=== Description===
=== Description===
The Joomla Help Screens (over 200 help screens) are available on JDocs but most of all accessible from the backend of any Joomla sites, using the help button, to help users understanding each single feature/option and how to use them.<br />
Content follows soon
The Help Screens for Joomla 4 needs to be started from scratch, due to the important change between the 3.x and the 4.x series.


=== Related materials ===
=== Related materials ===
* Install of Joomla 4:
*  
**[https://github.com/joomla/joomla-cms/tree/4.0-dev GitHub]
**[https://developer.joomla.org/nightly-builds.html Nightly builds]
**[https://launch.joomla.org Launch Joomla]
*[[S:MyLanguage/Category:Help_screen_3.9|Joomla 3.9 Help Screens]]


== Project 3: Update of the J3.x Documentation ==
With the forthcoming Joomla 4 release, a lot of Joomla 3.x documentation needs to be updated to fit J3.9 and most important to fit the changes introduced into Joomla 4 (like for example, the 4 main portals: beginners, administrators, developers, core contributors). <br />
The task will mostly consist into duplicating the J3.x tutorials, using the right namespace and update the content to fit the new version, so that we can keep the J3.x documentation alongside with J4.x documentation.
Some pages will also need to be urevie
=== Related materials ===
* Install of Joomla 4:
**[https://github.com/joomla/joomla-cms/tree/4.0-dev GitHub]
**[https://developer.joomla.org/nightly-builds.html Nightly builds]
**[https://launch.joomla.org Launch Joomla]
*[[S:MyLanguage/Category:Joomla!_3.x|Joomla 3.x Category]]
**Example of pages to update:
***https://docs.joomla.org/J3.x:Adding_custom_fields
***https://docs.joomla.org/J3.x:Creating_a_simple_module
***https://docs.joomla.org/J3.x:Multilingual_Associations
***https://docs.joomla.org/J3.x:Setup_a_Multilingual_Site
***https://docs.joomla.org/J3.x:Getting_Started_with_Joomla!
***https://docs.joomla.org/Layout_Overrides_in_Joomla
***https://docs.joomla.org/J3.x:Using_the_JToolbar_class_in_the_frontend
***https://docs.joomla.org/J3.x:Installing_Joomla
***https://docs.joomla.org/J3.x:How_to_use_the_Template_Manager
***https://docs.joomla.org/How_do_you_recover_or_reset_your_admin_password
***https://docs.joomla.org/J3.x:Setup_a_Multilingual_Site
* The 4 main portals:
**Example of pages to update:
***[[S:MyLanguage/Portal:Beginners|Beginners]]
***[[S:MyLanguage/Portal:Administrators|Administrators]]
***[[S:MyLanguage/Portal:Developers|Developers]]
***[[S:MyLanguage/Portal:Joomla!_Code_Contributors|Joomla Code Contributors]]


== Mentors ==
== Mentors ==
Line 76: Line 37:
*[mailto:shivamdiehard@gmail.com Shivam Rajput]
*[mailto:shivamdiehard@gmail.com Shivam Rajput]
*[mailto:mike.brandner@community.joomla.org Mike Brandner]
*[mailto:mike.brandner@community.joomla.org Mike Brandner]
*[mailto:harald.leithner@community.joomla.org Harald Leithner]
*[mailto:benjamin.trenkle@community.joomla.org Benjamin Trenkle]





Revision as of 13:14, 23 July 2022

Welcome to Joomla GSoD 2023
Project Ideas Page
The application for technical writers is going to open soon!

Welcome to the Joomla Google Season of Docs (GSoD) 2023 project ideas page.

If you are interested in participating as a technical writer please review the materials on applying that are available at Google. We strongly encourage you to ask questions about process and projects on our joomla-gsoc mailing list and join our public Glip / Ringcentral chat tool.
You can contact the Joomla GSoD team at gsod@community.joomla.org

Note: The GSoD 2023 projects are displayed in no particular order

GSoD 2023 will focus on providing technical documentation about Joomla 4, our major project release which should be available by the end of 2023. Providing a good documentation about new features is crucial for a project like Joomla, so that users and developers can upgrade or try the new major version in a smooth way. See also the Joomla 4 Tutorials Project

Project 1: Joomla! User Guide

Description

Content follows soon

Related materials

Project 2: Joomla! Developer Documentation

Description

Content follows soon

Related materials


Mentors