Add and complete readme.txt

[mauteri]

We only need a README.md (not a readme.txt). Let's bring these together into just the README.md and remove the readme.txt.

More info here: https://johnblackbourn.com/readme-md-plugin-on-wordpress-org/

Example of how to format here: https://github.com/johnbillion/user-switching/blob/develop/readme.md

[mauteri]

@patriciabt I think this is all done, right?

[patriciabt]

@mauteri

• for "[WIP] Documentation Outline", I could add some screen captures, and remove the [WIP] and the word Outline
• for "Developer Documentation", you know better than me if you have to add to that section, as I have no idea :)

[mauteri]

Ok great, if you can handle first bullet point that would be awesome. I'll handle second bullet point. Thx!

[carstingaxion]

We should not forget about, what @jeffpaul noted in the closed PR:

Still needed is:

• Update the description of the GatherPress repo from the No description, website, or topics provided. placeholder to GatherPress, powering our community's event management needs. or something like that.
• Generate a plugin header image and add to the repo (.wordpress-org folder so they'll get deployed to WP.org on the next release published there)
• Generate some plugin screenshots and add those to the repo and reference in the readme files

and like @mauteri and me concluded in the GatherPress slack channel, we should also:

• Use only a README.md file, which is also valid for wp.org since 2015

[jeffpaul]

The following one is done:

• Generate a plugin header image and add to the repo (.wordpress-org folder so they'll get deployed to WP.org on the next release published there)

See: https://github.com/GatherPress/gatherpress/blob/main/.wordpress-org/banner-1544x500.jpg && https://github.com/GatherPress/gatherpress/blob/main/.wordpress-org/icon-256x256.jpg

[carstingaxion]

I'd like to start working on this one.

[patriciabt]

@carstingaxion
We can do it together.
This post by John Blackbourn is what was mentioned during the meeting

• We remove the readme.txt and keep only the readme.md
• I see with @mauteri for the team member list update
• You gather all technical/dev information to be added/modified/removed
• I do the same for all non technical information

If that's OK for you?

[carstingaxion]

@patriciabt If that's OK for you?

Absolutely.

But, now that you respond, I remember that you wanted to deal with that README. I'm sorry, I didn't wanted to step on your foot, be earlier or start mansplaining in any way.

[patriciabt]

@carstingaxion
That's so kind to mention that, but absolutely no worries at all, on the contrary!
Especially that I have no idea about all the things to mention :) related to that: Undocumented use of a 3rd Party or external service #610

Thanks a lot!

[carstingaxion]

Great @patriciabt , let's start!

[carstingaxion]

related to that: #610

I'm unsure too, because I can't remember any plugin in the repository linking to TOS or privacy policies of 3rd-parties.

Let's go on with what @jeffpaul suggested:

= What external services are used in GatherPress? =

We utilize Open Street Maps to render meeting locations in a map form. In order to do so we send the address to OSM in order to render their map.

etc...

including the mentioned links.

[carstingaxion]

A fast research reveals, that there might still be a misunderstanding at the plugin review process AND our interpretation.

For example, the following plugins are NOT providing any terms-of-service or privacy links AT ALL:

• WP Map Block – Gutenberg Map Block for Google Map and OpenStreet Map – WordPress plugin | WordPress.org
• The Events Calendar – WordPress plugin | WordPress.org
• Leaflet Map – WordPress plugin | WordPress.org
• Geolocation – WordPress plugin | WordPress.org
• Simple Location – WordPress plugin | WordPress.org
• OSM – OpenStreetMap – WordPress plugin | WordPress.org

Maybe the .org plugin review team just stumbled upon 'PRODID:-//GatherPress//RemoteApi//EN', which is a part of the iCal standard to write it that way, I think. This is not a reference to an external service.

[carstingaxion]

You gather all technical/dev information to be added/modified/removed

For the beginning I just moved all dev-related docs into separate file, which can be updated in the future #656 . For now and to get the plugin into the repo, I think we better go on with the essentials.

[carstingaxion]

I made some screenshots.

Which ones, what else and how many should we use?

And yes, I'm going to polish the edges before committing the files.

Or do we want something more fancy, like I tried with the backgrounds here?

[carstingaxion]

Update the description of the GatherPress repo from the No description, website, or topics provided. placeholder to GatherPress, powering our community's event management needs. or something like that.

This is one is a 10-seconds-to-be-done-job, for someone with writing-access to this repo. @MervinHernandez or @mauteri , could one of you please help here?

[carstingaxion]

I would suggest merging the existing Credits section into the default readme-file-header and list all contributors only there.

[mauteri]

Update the description of the GatherPress repo from the No description, website, or topics provided. placeholder to GatherPress, powering our community's event management needs. or something like that.

This is one is a 10-seconds-to-be-done-job, for someone with writing-access to this repo. @MervinHernandez or @mauteri , could one of you please help here?

Done.

[mauteri]

I would suggest merging the existing Credits section into the default readme-file-header and list all contributors only there.

There's a CLI script that generates output of contributors. Currently it calls WP to get profile info and generates an array of profile information to display under Settings -> Credits. Maybe we can revisit this and create an .md file (as well as or instead of).

data files can be found in gatherpress/includes/data/credits

[carstingaxion]

I would suggest merging the existing Credits section into the default readme-file-header and list all contributors only there.

There's a CLI script that generates output of contributors. Currently it calls WP to get profile info and generates an array of profile information to display under Settings -> Credits. Maybe we can revisit this and create an .md file (as well as or instead of).

data files can be found in gatherpress/includes/data/credits

Yes, let us change the CLI to also update the README.md file with the wp.org profile-handles. This is something, that probably needs its own issue.

[carstingaxion]

I would suggest merging the existing Credits section into the default readme-file-header and list all contributors only there.

What I meant was more a try to simplify and DRY out the existing README. Don't get me wrong, I really, really like and appreciate showing who contributed and giving props to all the people, but the current duplication is not that nice, I think.

wp.org, takes all the handles from the file-header to create this list:

github shows a similar list, based on the git history:

The listing of wp.org profile links seems to be redundant. Let us remove the Credits section!

[carstingaxion]

I made some screenshots.

Which ones, what else and how many should we use?

Olá @patriciabt , I guess you are full in with WCEU preparation, but I'd love to read your thoughts on the images.

If you could take the time, it would be very nice.
Thanks!

[carstingaxion]

Another thing that came to my mind was WordPress‘ Code of conduct. Did you - as the GatherPress team - talked or even decided anything related to any kind of community-rules?

I’d like suggest adding another short paragraph to „Contributing“ like this:

Please note that this project is adapting the Contributor Code of Conduct from WordPress.org even though this is not a WordPress project. By participating in this project you agree to abide by its terms.

[mauteri]

@carstingaxion yes, please add that. Thx!

[mauteri]

I would suggest merging the existing Credits section into the default readme-file-header and list all contributors only there.

What I meant was more a try to simplify and DRY out the existing README. Don't get me wrong, I really, really like and appreciate showing who contributed and giving props to all the people, but the current duplication is not that nice, I think.

wp.org, takes all the handles from the file-header to create this list:

github shows a similar list, based on the git history:

The listing of wp.org profile links seems to be redundant. Let us remove the Credits section!

@carstingaxion yes, we can remove that section from readme. That is fine. For the CLI script I'll manage the README.md to be populated by the CLI script that also creates the credits section within the plugin. Thx!