Documentation for PR Topic is solved

Joomla! Documentation Workgroup

Moderator: Documentation

Post Reply
MarkRS
Joomla! Explorer
Joomla! Explorer
Posts: 351
Joined: Thu Oct 29, 2009 8:28 am
Location: UK

Documentation for PR

Post by MarkRS » Sat Apr 27, 2024 11:59 am

I've some hope that my PR (#41496) may eventually find its way into the core so I want to write documentation for it, as the repo makes a point of requesting. Unfortunately I've not been able to find out how or where to do that. Could somebody point me in the right direction please.

Many thanks
It's a community, the more we all contribute, the better it will be.

User avatar
ceford
Joomla! Hero
Joomla! Hero
Posts: 2800
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Documentation for PR

Post by ceford » Sat Apr 27, 2024 3:02 pm


MarkRS
Joomla! Explorer
Joomla! Explorer
Posts: 351
Joined: Thu Oct 29, 2009 8:28 am
Location: UK

Re: Documentation for PR

Post by MarkRS » Mon Apr 29, 2024 8:06 am

Thanks for that ceford.
I may be being thick, but I can't see where that tells me how to write & submit documentation to support a change to core functionality. I did find it previously and looked.
It's a community, the more we all contribute, the better it will be.

SharkyKZ
Joomla! Hero
Joomla! Hero
Posts: 2992
Joined: Fri Jul 05, 2013 10:35 am
Location: Parts Unknown

Re: Documentation for PR

Post by SharkyKZ » Mon Apr 29, 2024 8:24 am

The manual is the place to add documentation for new features. Its repository is here https://github.com/joomla/Manual. Other places affected by your changes should also be updated. For example, component development pages mentioning access.xml/config.xml structure.

MarkRS
Joomla! Explorer
Joomla! Explorer
Posts: 351
Joined: Thu Oct 29, 2009 8:28 am
Location: UK

Re: Documentation for PR

Post by MarkRS » Mon Apr 29, 2024 5:29 pm

Thanks for that SharkyKZ.

So it looks like editing is done by clicking the "Edit this page" link in the manual that you and ceford pointed me to, yes?

If so, how do I go about adding a page? I've had a look at the github repo directly and can't for the life of me work out how to do it there and I don't see an "add a new page" link in the manual.

My PR is about making access to component options controllable with the ACL model. I can't find anything about the options system in general in the manual. Again, perhaps I'm just not looking properly.

Mark
It's a community, the more we all contribute, the better it will be.

User avatar
ceford
Joomla! Hero
Joomla! Hero
Posts: 2800
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Documentation for PR

Post by ceford » Mon Apr 29, 2024 5:46 pm

It's the same as contributing to code: fork the repo, clone your copy, make a branch and then a PR with your changes.

dziller
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Tue Sep 27, 2016 7:34 am

Re: Documentation for PR

Post by dziller » Tue Apr 30, 2024 6:43 am

If you follow Ceford's tip, you will end up with an exact image of the GH repo on your local computer. Don't forget the step with the new branch.

The content of the current manual website is provided by the folder /versioned_docs/version-5.1/. Your new article should be inserted in the appropriate subfolder there.
If you are wondering which is the correct subfolder for your new content, it would be useful to ask the maintainers with an issue how to proceed in your case.
You can also ask this question in the documentation channel on Mattermost.

MarkRS
Joomla! Explorer
Joomla! Explorer
Posts: 351
Joined: Thu Oct 29, 2009 8:28 am
Location: UK

Re: Documentation for PR

Post by MarkRS » Tue Apr 30, 2024 7:20 am

Thank you dziller, that's very helpful.
It's a community, the more we all contribute, the better it will be.


Post Reply

Return to “docs.joomla.org - Feedback/Information”