GSoD 2023 Project Ideas - Revision history

Cmb: Some markup changes.

2022-08-15T21:17:45Z

Some markup changes.

← Older revision		Revision as of 21:17, 15 August 2022
Line 20:		Line 20:
	== <translate>Project 1: Joomla! User Guide</translate> ==		== <translate>Project 1: Joomla! User Guide</translate> ==

	=== <translate>About the ~~project~~</translate> ===		=== <translate>About the Project</translate> ===
	<translate>The Joomla! project needs a usable and easy to navigate guide specific for users and administrators of our CMS. The current documentation is outdated and contains a mix of documents, related to older unsupported versions and current versions and is not easy to navigate. The existing documentation contains also a mix of internal documentation and other pages, not related to the software itself. It is driven by MediaWiki and open for all who want to support the project by writing content. The page structure is not clear and unstructured. End users of the software are not able to find the helpful content without pain.</translate>		<translate>The Joomla! project needs a usable and easy to navigate guide specific for users and administrators of our CMS. The current documentation is outdated and contains a mix of documents, related to older unsupported versions and current versions and is not easy to navigate. The existing documentation contains also a mix of internal documentation and other pages, not related to the software itself. It is driven by MediaWiki and open for all who want to support the project by writing content. The page structure is not clear and unstructured. End users of the software are not able to find the helpful content without pain.</translate>

	=== <translate>Key ~~needs~~</translate> ===		=== <translate>Key Needs</translate> ===

	<translate>We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.</translate>		<translate>We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.</translate>

	==== <translate>Problems ~~we want~~ to ~~solve~~</translate> ====		==== <translate>Problems We Want to Solve</translate> ====

	<translate>Users can easily find the description they need to use the CMS. No more long searches and outdated information will confuse the user.</translate>		<translate>Users can easily find the description they need to use the CMS. No more long searches and outdated information will confuse the user.</translate>
Line 33:		Line 33:
	<translate>Good documentation also makes the CMS safer to use and thus also helps to make the web safer.</translate>		<translate>Good documentation also makes the CMS safer to use and thus also helps to make the web safer.</translate>

	==== <translate>Project ~~scopes~~</translate> ====		==== <translate>Project Scopes</translate> ====
	<translate>		<translate>
	* Setting up the website		* Setting up the website
Line 41:		Line 41:
	* Writing documentation</translate>		* Writing documentation</translate>

	==== <translate>Related ~~materials~~</translate> ====		==== <translate>Related Materials</translate> ====
	<translate>		<translate>
	*		*
Line 47:		Line 47:
	== <translate>Project 2: Joomla! Developer Documentation</translate> ==		== <translate>Project 2: Joomla! Developer Documentation</translate> ==

	=== <translate>About the ~~project~~</translate> ===		=== <translate>About the Project</translate> ===
	<translate>Currently we’re using a ~~mediawiki~~ which holds all the documentation for end-users, developers and integrators. This is very hard to maintain regarding the different released versions. A new initiative started to extract the developer part into a new GIT-based documentation which needs now to be filled.		<translate>Currently we’re using a MediaWiki which holds all the documentation for end-users, developers and integrators. This is very hard to maintain regarding the different released versions. A new initiative started to extract the developer part into a new GIT-based documentation which needs now to be filled.

	Joomla! ~~Changed~~ the release cycle to ~~release~~ a minor version every six ~~month~~ and have a new major version every two years. Based on that the developer documentation is re-versioned with every major version to reflect the current state of the code base and the “best practises”.		Joomla! changed the release cycle to bring out a minor version every six months and have a new major version every two years. Based on that, the developer documentation is re-versioned with every major version to reflect the current state of the code base and the “best practises”.
	In this project the version of the previous major version should be cleaned up to remove all deleted functions and the new features should be added. Also a migration path should be described for extension developers.		In this project the version of the previous major version should be cleaned up to remove all deleted functions and the new features should be added. Also a migration path should be described for extension developers.

	</translate>		</translate>

	==== <translate>Key ~~needs~~</translate> ====		==== <translate>Key Needs</translate> ====
	<translate>		<translate>
	* Code based documentation for developers		* Code based documentation for developers
	* ~~every~~ change in the code requires an update of the documentation		* Every change in the code requires an update of the documentation
	* Versioning through the different active and further Joomla! ~~Versions~~		* Versioning through the different active and further Joomla! versions
	* Navigation in different capitals (get ~~startet~~ / style guide / plugins / modules / components / ~~templates …~~)		* Navigation in different capitals (get started / style guide / plugins / modules / components / templates…)
	* API documentation (move from existing docs)		* API documentation (move from existing docs)

	</translate>		</translate>
	==== <translate>Problems ~~we want~~ to ~~solve~~</translate> ====		==== <translate>Problems We Want to Solve</translate> ====
	<translate>		<translate>
	* Instruction for developers, how to write code for ~~joomla~~		* Instruction for developers; how to write code for Joomla
	* Documentation up to date to the development		* Documentation up to date to the development

	</translate>		</translate>
	==== <translate>Project ~~scope~~</translate> ====		==== <translate>Project Scope</translate> ====
	<translate>		<translate>
	*		*
	</translate>		</translate>
	==== <translate>Related ~~materials~~</translate> ====		==== <translate>Related Materials</translate> ====
	<translate>		<translate>
	* ~~Link to GitHub repository~~ https://github.com/joomla/Manual		* [https://github.com/joomla/Manual The Joomla/Manual GitHub repository]
	</translate>		</translate>

Line 84:		Line 83:
	*[mailto:mike.brandner@community.joomla.org Mike Brandner]		*[mailto:mike.brandner@community.joomla.org Mike Brandner]
	*[mailto:benjamin.trenkle@community.joomla.org Benjamin Trenkle]		*[mailto:benjamin.trenkle@community.joomla.org Benjamin Trenkle]


	<noinclude>		<noinclude>

Franz.wohlkoenig: /* About the project */

2022-08-12T04:50:46Z

About the project

← Older revision		Revision as of 04:50, 12 August 2022
Line 48:		Line 48:

	=== <translate>About the project</translate> ===		=== <translate>About the project</translate> ===
	<translate>Currently we’re using aa mediawiki which holds all the documentation for end-users, developers and integrators. This is very hard to maintain regarding the different released versions. A new initiative started to extract the developer part into a new GIT-based documentation which needs now to be filled.		<translate>Currently we’re using a mediawiki which holds all the documentation for end-users, developers and integrators. This is very hard to maintain regarding the different released versions. A new initiative started to extract the developer part into a new GIT-based documentation which needs now to be filled.

	Joomla! Changed the release cycle to release a minor version every six month and have a new major version every two years. Based on that the developer documentation is re-versioned with every major version to reflect the current state of the code base and the “best practises”.		Joomla! Changed the release cycle to release a minor version every six month and have a new major version every two years. Based on that the developer documentation is re-versioned with every major version to reflect the current state of the code base and the “best practises”.

M-b-o: /* Project 2: Joomla! Developer Documentation */

2022-08-11T23:31:54Z

Project 2: Joomla! Developer Documentation

← Older revision		Revision as of 23:31, 11 August 2022
Line 48:		Line 48:

	=== <translate>About the project</translate> ===		=== <translate>About the project</translate> ===
	<translate>~~Content follows soon~~		<translate>Currently we’re using aa mediawiki which holds all the documentation for end-users, developers and integrators. This is very hard to maintain regarding the different released versions. A new initiative started to extract the developer part into a new GIT-based documentation which needs now to be filled.

			Joomla! Changed the release cycle to release a minor version every six month and have a new major version every two years. Based on that the developer documentation is re-versioned with every major version to reflect the current state of the code base and the “best practises”.
			In this project the version of the previous major version should be cleaned up to remove all deleted functions and the new features should be added. Also a migration path should be described for extension developers.

	</translate>		</translate>

	==== <translate>Key needs</translate> ====		==== <translate>Key needs</translate> ====
	<translate>		<translate>
	*		* Code based documentation for developers
			* every change in the code requires an update of the documentation
			* Versioning through the different active and further Joomla! Versions
			* Navigation in different capitals (get startet / style guide / plugins / modules / components / templates …)
			* API documentation (move from existing docs)

	</translate>		</translate>
	==== <translate>Problems we want to solve</translate> ====		==== <translate>Problems we want to solve</translate> ====
	<translate>		<translate>
	*		* Instruction for developers, how to write code for joomla
			* Documentation up to date to the development

	</translate>		</translate>
	==== <translate>Project scope</translate> ====		==== <translate>Project scope</translate> ====
Line 65:		Line 76:
	==== <translate>Related materials</translate> ====		==== <translate>Related materials</translate> ====
	<translate>		<translate>
	*		* Link to GitHub repository https://github.com/joomla/Manual
	</translate>		</translate>

	== <translate>Mentors</translate> ==		== <translate>Mentors</translate> ==

M-b-o at 15:41, 23 July 2022

2022-07-23T15:41:48Z

← Older revision		Revision as of 15:41, 23 July 2022
Line 75:		Line 75:

	<noinclude>		<noinclude>
	[[Category:Google Season of Docs ~~2019~~]]		[[Category:Google Season of Docs 2023]]
	[[Category:Google Season of Docs]]		[[Category:Google Season of Docs]]
	</noinclude>		</noinclude>

M-b-o at 15:39, 23 July 2022

2022-07-23T15:39:51Z

← Older revision		Revision as of 15:39, 23 July 2022
Line 1:		Line 1:
	{{underconstruction}}		{{underconstruction}}
	{{Top portal heading\|color=white-bkgd\|text-color=#333\|title=Welcome to Joomla GSoD 2023 <br />Project Ideas Page }}		<noinclude><languages /></noinclude>
			{{Top portal heading\|color=white-bkgd\|text-color=#333\|title=<translate>Welcome to Joomla GSoD 2023</translate> <br /><translate>Project Ideas Page</translate> }}
	[[Image:Gsod2019.png\|300px\|center]]		[[Image:Gsod2019.png\|300px\|center]]

	{{tip\|title=The application for technical writers is going to open soon!}}		{{tip\|title=<translate>The application for technical writers is going to open soon!</translate>}}

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

	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].		<translate>If you are interested in participating as a technical writer please review the materials on applying that are available at</translate> [https://developers.google.com/season-of-docs/docs/tech-writer-application-hints Google].
	We strongly encourage you to ask questions about process and projects on our [https://groups.google.com/forum/#!forum/jgsoc joomla-gsoc mailing list] and join our		<translate>We strongly encourage you to ask questions about process and projects on our</translate> [https://groups.google.com/forum/#!forum/jgsoc joomla-gsoc <translate>mailing list</translate>] <translate>and join our</translate>
	[https://glip.com/joomla public Glip / Ringcentral chat tool].<br />		[https://glip.com/joomla public Glip / <translate>Ringcentral chat tool</translate>].<br />
	You can contact the Joomla GSoD team at gsod@community.joomla.org		<translate>You can contact the Joomla GSoD team at</translate> gsod@community.joomla.org

	'''''Note: The GSoD 2023 projects are displayed in no particular order'''''		'''''<translate>Note: The GSoD 2023 projects are displayed in no particular order</translate>'''''

	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.		<translate>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.</translate>
	See also the [[JDOC:Joomla_4_Tutorials_Project\| Joomla 4 Tutorials Project]]		<translate>See also the</translate> [[JDOC:Joomla_4_Tutorials_Project\| <translate>Joomla 4 Tutorials Project</translate>]]

	== Project 1: Joomla! User Guide ==		== <translate>Project 1: Joomla! User Guide</translate> ==

	=== About the project ===		=== <translate>About the project</translate> ===
	The Joomla! project needs a usable and easy to navigate guide specific for users and administrators of our CMS. The current documentation is outdated and contains a mix of documents, related to older unsupported versions and current versions and is not easy to navigate. The existing documentation contains also a mix of internal documentation and other pages, not related to the software itself. It is driven by MediaWiki and open for all who want to support the project by writing content. The page structure is not clear and unstructured. End users of the software are not able to find the helpful content without pain.		<translate>The Joomla! project needs a usable and easy to navigate guide specific for users and administrators of our CMS. The current documentation is outdated and contains a mix of documents, related to older unsupported versions and current versions and is not easy to navigate. The existing documentation contains also a mix of internal documentation and other pages, not related to the software itself. It is driven by MediaWiki and open for all who want to support the project by writing content. The page structure is not clear and unstructured. End users of the software are not able to find the helpful content without pain.</translate>

	=== Key needs ===		=== <translate>Key needs</translate> ===

	We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.		<translate>We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.</translate>

	==== Problems we want to solve ====		==== <translate>Problems we want to solve</translate> ====

	Users can easily find the description they need to use the CMS. No more long searches and outdated information will confuse the user.		<translate>Users can easily find the description they need to use the CMS. No more long searches and outdated information will confuse the user.</translate>

	Good documentation also makes the CMS safer to use and thus also helps to make the web safer.		<translate>Good documentation also makes the CMS safer to use and thus also helps to make the web safer.</translate>

	~~==== Project scopes ====~~

			==== <translate>Project scopes</translate> ====
			<translate>
	* Setting up the website		* Setting up the website
	* Setting up multilingual functionalities		* Setting up multilingual functionalities
	* Navigation structure for beginners, maintenance, admins …		* Navigation structure for beginners, maintenance, admins …
	* Taking screenshots		* Taking screenshots
	* Writing documentation		* Writing documentation</translate>

	==== Related materials ====		==== <translate>Related materials</translate> ====
			<translate>
	*		*
			</translate>
			== <translate>Project 2: Joomla! Developer Documentation</translate> ==

	== ~~Project 2: Joomla! Developer Documentation~~ ==		=== <translate>About the project</translate> ===
			<translate>Content follows soon
			</translate>

	~~=== About the project ===~~		==== <translate>Key needs</translate> ====
	~~Content follows soon~~		<translate>

	==== Key needs ====
	*		*
			</translate>
	==== Problems we want to solve ====		==== <translate>Problems we want to solve</translate> ====
			<translate>
	*		*
			</translate>
	==== Project scope ====		==== <translate>Project scope</translate> ====
			<translate>
	*		*
			</translate>
	==== Related materials ====		==== <translate>Related materials</translate> ====
			<translate>
	*		*
			</translate>
	== Mentors ==		== <translate>Mentors</translate> ==

	*[mailto:shivamdiehard@gmail.com Shivam Rajput]		*[mailto:shivamdiehard@gmail.com Shivam Rajput]

M-b-o: /* Key needs = */

2022-07-23T15:13:48Z

Key needs =

← Older revision		Revision as of 15:13, 23 July 2022
Line 48:		Line 48:
	Content follows soon		Content follows soon

	==== Key needs =====		==== Key needs ====
	*		*

M-b-o: /* About the project */

2022-07-23T15:13:33Z

About the project

← Older revision		Revision as of 15:13, 23 July 2022
Line 47:		Line 47:
	=== About the project ===		=== About the project ===
	Content follows soon		Content follows soon

			==== Key needs =====
			*

	==== Problems we want to solve ====		==== Problems we want to solve ====
			*

	==== Project scope ====		==== Project scope ====
			*

	==== Related materials ====		==== Related materials ====

M-b-o: /* Problems we want to solve */

2022-07-23T14:35:57Z

Problems we want to solve

← Older revision		Revision as of 14:35, 23 July 2022
Line 28:		Line 28:
	==== Problems we want to solve ====		==== Problems we want to solve ====

			Users can easily find the description they need to use the CMS. No more long searches and outdated information will confuse the user.

			Good documentation also makes the CMS safer to use and thus also helps to make the web safer.

	==== Project scopes ====		==== Project scopes ====

M-b-o: /* Project scope */

2022-07-23T14:28:06Z

Project scope

← Older revision		Revision as of 14:28, 23 July 2022
Line 29:		Line 29:


	==== Project ~~scope~~ ====		==== Project scopes ====

			* Setting up the website
			* Setting up multilingual functionalities
			* Navigation structure for beginners, maintenance, admins …
			* Taking screenshots
			* Writing documentation

	==== Related materials ====		==== Related materials ====

M-b-o: /* Key needs */

2022-07-23T14:25:52Z

Key needs

← Older revision		Revision as of 14:25, 23 July 2022
Line 25:		Line 25:

	We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.		We need a simply structured page as a guide for the users of the software. It should work as a guide to lead the users step by step through the using of the CMS.


	==== Problems we want to solve ====		==== Problems we want to solve ====