Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Add demo link to documentation #826

Open
maltfield opened this issue Jul 30, 2024 · 8 comments
Open

Feature Request: Add demo link to documentation #826

maltfield opened this issue Jul 30, 2024 · 8 comments

Comments

@maltfield
Copy link

What

This is a request to

  1. Create at least one dedicated "demo" wordpress website with this ActivityPub plugin enabled, and
  2. Link to ^ this website somewhere on [a] this repo's README.md file and [b] this plugin's main page

Why

It's really unclear what this plugin does and does not do, but a demo says a thousand words

How

  1. Spin up a new wodpress site, enable this plugin, publish some content
  2. Update the docs to link to it
@pfefferle
Copy link
Member

I added a playground link to the WordPress.org repo, so that you can (at least) check the settings screens directly in your browser.

@carstingaxion
Copy link

I added a playground link to the WordPress.org repo, so that you can (at least) check the settings screens directly in your browser.

But did you also enable the feature on your plugin page @pfefferle ?

Because it’s not there, unfortunately.

@maltfield
Copy link
Author

I can't find any links to any demos. I don't understand what was changed. Can you please paste a link that shows what you mean?

@pfefferle
Copy link
Member

Sorry, WordPress.org changed something and I had to opt-in! Now you can see a "Live Preview" button at the top!

image

@maltfield
Copy link
Author

maltfield commented Aug 29, 2024

For clarity, @pfefferle appears to have updated the contents of this page:

The image that he uploaded in the last comment shows a screenshot of the above page, showing a button that says Live Preview next to a button that says Download

If you click on the Live Preview button, then it takes you to this page:

Unfortunately, when I click the Live Preview button, I get an empty white page.

I'm afraid you may have misinterpreted my ticket. I don't think we need to have a link to a demo of this plugin's backend (especially if that's so complicated that it's just not going to work for many users). I think we simply need a link to some website running this plugin. Just a demo of the frontend is fine.

I still don't really know what this plugin does, but I'm expecting to see something like a mastodon feed. I want to see some wordpress site with that ActivityPub feed and click around to see what it looks like.

I do know that this plugin's page (linked above) enumerates some wordpress blocks that are implemented by this plugin. The demo site should include each of those blocks, so we can "see" exactly what they do.

@pfefferle
Copy link
Member

pfefferle commented Aug 29, 2024

The thing is, that there is no change to a site if it activates the plugin! It still looks the same as before. Sure, you can check out the blocks but they simply help with following or shows the followers!

The plugin makes no mastodon out of your blog, it simply enables ActivityPub so that others can follow your blog.

@pfefferle
Copy link
Member

Here is my demo site: https://pfefferle.wordpress.com

And here you can see the blocks: https://pfefferle.wordpress.com/fediverse/

@maltfield
Copy link
Author

maltfield commented Aug 29, 2024

The thing is, that there is no change to a site if it activates the plugin! It still looks the same as before. Sure, you can check out the blocks but they simply help with following or shows the followers!

The plugin makes no mastodon out of your blog, it simply enables ActivityPub so that others can follow your blog.

This is great info, and I think it should be clearly documented on this repo's README.md and the wordpress.org plugin page

Here is my demo site: https://pfefferle.wordpress.com

And here you can see the blocks: https://pfefferle.wordpress.com/fediverse/

This is exactly what I'm looking for, thank you. Can you please add links to these (the second one is especially important) on this repo's README and the wordpress.org plugin page (under a new section titled "Demo")?

I can submit also submit a PR, if you'd like?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants