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

Fix microsite compile #1231

Merged
merged 1 commit into from
Jun 1, 2020
Merged

Fix microsite compile #1231

merged 1 commit into from
Jun 1, 2020

Conversation

rpless
Copy link
Collaborator

@rpless rpless commented May 25, 2020

Our microsite build has been broken and outdated while we've been moving to an Effect Agnostic Endpoint. This PR fixes the sbt docs/makeMicrosite command. The code examples in the docs all compile but the text that surrounds them is still out of date. My current thinking is that we can use this as a base to fix the text, although I'm open to alternative approaches to fixing our docs. If we decide to merge this, I don't think we should publish the docs to the website until all the text has been fixed.

Some things to note / questions:

  • I replaced the Server Sent Event example's use of AsyncStream with Fs2
  • The latest sbt-microsites seems to replace favicons and icons with its own. I've noticed this on other microsites like cats effect.
  • Set the docs compilation tool to Tut, but we should probably consider moving to mdoc in the future
  • contributing.md probably needs to get updated to no longer mention Waffle which no longer exists

…oints. This only commit only fixes docs/makeMicrosite and does not include updates to the written content of the documentation
@codecov-commenter
Copy link

Codecov Report

Merging #1231 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1231   +/-   ##
=======================================
  Coverage   81.07%   81.07%           
=======================================
  Files          55       55           
  Lines        1009     1009           
  Branches       42       42           
=======================================
  Hits          818      818           
  Misses        191      191           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 78b2f15...c9b28fe. Read the comment docs.

Copy link
Collaborator

@sergeykolbasov sergeykolbasov left a comment

Choose a reason for hiding this comment

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

That's great!

Thanks a lot @rpless

@sergeykolbasov
Copy link
Collaborator

What I did in Odin is to compile docs on each PR, so it becomes a part of the check, as well as automatically compile and publish documentation back on GitHub during release. I guess we might onboard similar mechanism here to avoid severe discrepancy between documentation and actual code.

@rpless
Copy link
Collaborator Author

rpless commented Jun 1, 2020

I like the sound of publishing on release. It might also be related to #1002. I'm going to merge this and will look at more fixes so we can get ready for a release.

@rpless rpless merged commit 5137cc4 into finagle:master Jun 1, 2020
@rpless rpless deleted the rpless/fix-docs branch June 1, 2020 13:39
@rpless rpless mentioned this pull request Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants