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

WIP: Working With Content as new Classic UI user guide #1547

Draft
wants to merge 7 commits into
base: 6.0
Choose a base branch
from

Conversation

tkimnguyen
Copy link
Sponsor Member

No description provided.

@netlify
Copy link

netlify bot commented Oct 7, 2023

Deploy Preview for 6-docs-plone-org ready!

Name Link
🔨 Latest commit fcb23a8
🔍 Latest deploy log https://app.netlify.com/sites/6-docs-plone-org/deploys/65297a820a1c360008d4a4fa
😎 Deploy Preview https://deploy-preview-1547--6-docs-plone-org.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkimnguyen did you review any of this content for accuracy? If not, then do not put it into a PR. When you create a PR, you assert its content is correct and should be merged.

Also I am concerned about 194 files in a PR. One way of dealing with a large volume of content is to create a feature branch from 6.0. Then add (commit) one page at a time on a yet another new branch created from your feature branch, and then create a PR for that branch against the feature branch that we can review.

---
myst:
html_meta:
"description": "User Guide for Plone 6 Classic"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace any and all instances of "Classic" with "Classic UI".

Suggested change
"description": "User Guide for Plone 6 Classic"
"description": "User Guide for Plone 6 Classic UI"

Copy link
Sponsor Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@tkimnguyen
Copy link
Sponsor Member Author

I'm not really following. I wanted to help get the missing section into the docs. I was not planning on making a huge effort rewriting or rereading/verifying this content at this time. It's a work in progress. I'm not going to make 194 commits. I'm happy working on getting Volto user docs into this repository.

@stevepiercy
Copy link
Contributor

I'm sorry I was not clear. Accuracy in documentation is the most important thing.

We do not want to publish docs in Plone 6 that have not been verified for Plone 6. It would be a disservice to visitors. We only add value to Plone 6 docs when the content has been verified for Plone 6.

Plone 5 and earlier versions of docs belong in those versions and will remain available.

@tkimnguyen tkimnguyen marked this pull request as draft October 7, 2023 20:24
@tkimnguyen
Copy link
Sponsor Member Author

I understand. I will review the content to see how close it is to Plone 6.

@tkimnguyen
Copy link
Sponsor Member Author

So far I've found stuff like:

  • links to plone.com
  • mention of Plone 5
  • mention of Internet Explorer
  • some wording that I would change

Would I need to fix things like that before you'd approve this PR?

@stevepiercy
Copy link
Contributor

Yes. But seriously, there is no way I can review and approve 194 files in one swoop. Can you please just do one or a few pages at a time? It's OK if we do this in smaller chunks, like we're doing with all the other Plone 5 docs.

@tkimnguyen
Copy link
Sponsor Member Author

But those 194 files are EXACTLY what was in the Plone 5 docs with the exception of a handful of screenshots I had to recreate by hand because they were missing

@tkimnguyen
Copy link
Sponsor Member Author

Not only do I think you should be ok accepting those 194 files in one commit, I do not understand how to do what you're asking me to do.

@tkimnguyen
Copy link
Sponsor Member Author

if anyone is spectating, Steve and I got together on Discord and came up with a plan to move forward (e.g., creating a new branch off this one into which I can make revisions, section by section, and make smaller PRs into this branch that he can review)

@tkimnguyen
Copy link
Sponsor Member Author

"cage match"

@stevepiercy
Copy link
Contributor

"cage match"

It is so on!

image

@davisagli
Copy link
Sponsor Member

If 2 Plonistas meet in a cage but no one is there to watch, does it make a sound?

@tkimnguyen
Copy link
Sponsor Member Author

"It is a tale told by an idiot[s], full of sound and fury, signifying nothing" – https://www.enotes.com/topics/macbeth/questions/macbeth-says-it-is-a-tale-told-by-an-idiot-full-42403

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

Successfully merging this pull request may close these issues.

None yet

3 participants