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

Document Reusable Editor Components #3420

Closed
29 tasks
youknowriad opened this issue Nov 10, 2017 · 1 comment
Closed
29 tasks

Document Reusable Editor Components #3420

youknowriad opened this issue Nov 10, 2017 · 1 comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Type] Developer Documentation Documentation for developers

Comments

@youknowriad
Copy link
Contributor

youknowriad commented Nov 10, 2017

In #2761 we're moving several Editor components to the editor/components folder making them reusable to build custom editor layouts. These components were not meant to be reusable at first, so we need to document their external APIs.

Let's go over these components one by one and:

  • Add a README for the component
  • Rename the component if necessary (some components need to be prefixed by Post like PostDocumentOutline
  • Ensure these components follow our CSS coding guidelines (the classnames)
  • If the styles of these components contain any "layout" style making them not easily usable outside the Post Editor context, make sure to refactor these styles out of the component base style.

Here's the list of the components make sure to reference this issue if you work on one of these:

  • AutosaveMonitor
  • BlockInspector
  • BlockToolbar
  • DocumentOutline
  • Inserter
  • MetaBoxes
  • PageAttributes
  • PostAuthor
  • PostComments
  • PostExcerpt
  • PostFeaturedImage
  • PostFormat
  • PostLastRevision
  • PostPendingStatus
  • PostPingbacks
  • PostPreviewButton
  • PostPublishButton
  • PostSavedState
  • PostSchedule
  • PostSticky
  • PostTextEditor
  • PostTitle
  • PostTaxonomies
  • PostTrash
  • PostVisibility
  • Provider
  • UnsavedChangesWarning
  • WordCount
  • WritingFlow

Thanks for your help

@youknowriad youknowriad added [Type] Developer Documentation Documentation for developers Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Nov 10, 2017
@youknowriad
Copy link
Contributor Author

I was hoping new contributors will come and document some of these components. I'm going to close this issue as hardly actionable directly. Let's make sure to document the components as we update them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

1 participant