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

docs: making updates to Editor Guide #20258

Merged

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Oct 18, 2023

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

This PR makes a couple of updates in the Editor Guide. I noticed that when scheduling a post to be published the next day, the message, "This URL is public but secret, so share at your own discretion". After raising this issue to @michael-tharrington and learning that posts will only appear in feeds and on a user's profile when they are published on the day they are scheduled. Through another conversation, Michael pointed out that the bullet point about the Markdown editor needs to be updated since Dev.to now has two editors. By making these adjustments, users would gain a better understanding of how to edit and publish their posts.

Related Tickets & Documents

Not applicable

  • Related Issue #
  • Closes #

QA Instructions, Screenshots, Recordings

mention in editor guide

UI accessibility checklist

If your PR includes UI changes, please utilize this checklist:

  • Semantic HTML implemented?
  • Keyboard operability supported?
  • Checked with axe DevTools and addressed Critical and Serious issues?
  • Color contrast tested?

For more info, check out the
Forem Accessibility Docs.

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

  • Yes
  • No, and this is why: please replace this line with details on why tests
    have not been included
  • I need help with writing tests

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

alt_text

@CBID2 CBID2 requested a review from a team as a code owner October 18, 2023 22:57
@CBID2 CBID2 requested review from lightalloy and maestromac and removed request for a team October 18, 2023 22:57
@CLAassistant
Copy link

CLAassistant commented Oct 18, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link
Contributor

Thank you for opening this PR! We appreciate you!

For all pull requests coming from third-party forks we will need to
review the PR before we can process it through our CI pipelines.

A Forem Team member will review this contribution and get back to
you as soon as possible!

@github-actions
Copy link
Contributor

github-actions bot commented Oct 19, 2023

Uffizzi Preview deployment-38927 was deleted.

Copy link
Contributor

@michael-tharrington michael-tharrington left a comment

Choose a reason for hiding this comment

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

I think this is right, though I asked @CBID2 (Chrissy) to add a period. And also, is there any way I can see what this message is going to look like once it appears on DEV?

@michael-tharrington
Copy link
Contributor

michael-tharrington commented Oct 20, 2023

@CBID2, I know we chatted about this a good bit over Discord, but here's what I'm thinking, let's make this change to the Things to Know section instead.

Screen Shot 2023-10-20 at 4 04 48 PM

And actually, we have the opportunity to make 2 changes!

Here's what I'm thinking (changes in bold):

  • We use a markdown editor that uses Jekyll front matter.
  • Most of the time, you can write inline HTML directly into your posts.
  • We support native Liquid tags and created some fun custom ones, too! Trying embedding a Tweet or GitHub issue in your post, using the complete URL: {% embed https://... %}.
  • Links to unpublished posts (drafts or scheduled posts) are shareable for feedback/review. These posts have a notice which reads "This URL is public but secret, so share at your own discretion." They are not visible in feeds or on your profile until published.
  • When you're ready to publish, set the published variable to true or click publish depending on the editor version, you're using.

@CBID2 CBID2 changed the title feat: add information about message that appears when scheduling posts docs: making updates to Editor Guide Oct 20, 2023
@CBID2
Copy link
Contributor Author

CBID2 commented Oct 20, 2023

Hi @lightalloy! :) The updates have been made, and now my PR is ready to be merged! :)

@lightalloy lightalloy requested review from michael-tharrington and removed request for lightalloy October 21, 2023 14:49
@codecov
Copy link

codecov bot commented Oct 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

see 3 files with indirect coverage changes

📢 Thoughts on this report? Let us know!.

Copy link
Contributor

@benhalpern benhalpern left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for the contribution @CBID2!

@michael-tharrington we can verify this in production via the Uffizzi link in the PR — will show us just what it looks like.

@benhalpern benhalpern merged commit 4337161 into forem:main Oct 24, 2023
34 checks passed
@CBID2 CBID2 deleted the adding-information-about-scheduled-posts-url branch October 24, 2023 18:26
@CBID2
Copy link
Contributor Author

CBID2 commented Oct 24, 2023

Woohoo! 😊 Thanks @benhalpern

@michael-tharrington
Copy link
Contributor

Nice @benhalpern! Thanks for merging.

I think I just need a little demo on where to go to see the Uffizzi link. But I trust this is in good shape. @CBID2 talked about the plans for this one at length in Discord... btw, nice work Chrissy! 🙌

@michael-tharrington michael-tharrington added the hacktoberfest-accepted We have accepted the PR for Hacktoberfest but are delaying deployment for a specific reason label Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted We have accepted the PR for Hacktoberfest but are delaying deployment for a specific reason
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants