Skip to content

Add docs around using duckly for collaboration #4144

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

Merged
merged 5 commits into from
Sep 13, 2021
Merged

Conversation

galesky
Copy link
Contributor

@galesky galesky commented Sep 12, 2021

Fixes #3970

I used this PR #3903 as a reference of how to go about adding a new docs page

@galesky galesky requested a review from a team as a code owner September 12, 2021 17:57
{
"title": "Collaboration",
"description": "How to setup real time collaboration using code server.",
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6zm16-4H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z\"></path></svg>",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is using the same icon from the Usage section. I did not know from which icon library to get a new one, will need some help with that

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

@BrunoQuaresma can you let us know which icon we should use for Collaboration and help @galesky out here?

Copy link
Contributor

@BrunoQuaresma BrunoQuaresma Sep 13, 2021

Choose a reason for hiding this comment

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

Here is the SVG

<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M12.2 13.4357L9.5 11.4357C10.4 10.7357 11 9.7357 11 8.5357V7.7357C11 5.8357 9.6 4.1357 7.7 4.0357C5.7 3.9357 4 5.5357 4 7.5357V8.5357C4 9.7357 4.6 10.7357 5.5 11.4357L2.8 13.5357C2.3 13.9357 2 14.5357 2 15.1357V17.0357C2 17.6357 2.4 18.0357 3 18.0357H12C12.6 18.0357 13 17.6357 13 17.0357V15.0357C13 14.4357 12.7 13.8357 12.2 13.4357Z"/>
<path d="M17.1 8.43436L15.3 7.23436C15.7 6.83436 16 6.23436 16 5.53436V4.63436C16 3.43436 15.1 2.23436 13.9 2.03436C12.7 1.83436 11.7 2.53436 11.2 3.43436C12.3 4.43436 13 5.83436 13 7.43436V8.43436C13 9.33436 12.8 10.2344 12.4 10.9344C12.4 10.9344 13.6 11.8344 13.6 11.9344H17C17.6 11.9344 18 11.5344 18 10.9344V10.1344C18 9.43436 17.7 8.83436 17.1 8.43436Z"/>
</svg>

Here is the icon:
Screen Shot 2021-09-13 at 15 44 00

Copy link
Contributor

Choose a reason for hiding this comment

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

Amazing! Thanks @BrunoQuaresma

@galesky do you mind using this SVG instead? Then you can @ me once it's changed and we can get this merged

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @BrunoQuaresma!

I just committed the new SVG, I think we are ready to merge

It's a pity that the 'docs preview pipeline' is failing :(

Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome!

I know, we're super sorry about that :( We just added it a couple weeks ago and didn't anticipate this issue. I added it to the next milestone so it's being prioritized: #4027

I'll merge this!

Thank you again! ♥️

@codecov
Copy link

codecov bot commented Sep 12, 2021

Codecov Report

Merging #4144 (7be9972) into main (bc3acb0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4144   +/-   ##
=======================================
  Coverage   64.22%   64.22%           
=======================================
  Files          36       36           
  Lines        1873     1873           
  Branches      379      379           
=======================================
  Hits         1203     1203           
  Misses        569      569           
  Partials      101      101           

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 bc3acb0...7be9972. Read the comment docs.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

Thanks for starting our "Collaboration" doc! Requested a few changes, but looks good to me. I'll defer to the rest of the team though :)

I asked about the icon. We should definitely document that.

{
"title": "Collaboration",
"description": "How to setup real time collaboration using code server.",
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6zm16-4H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z\"></path></svg>",
Copy link
Member

Choose a reason for hiding this comment

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

Co-authored-by: Ben Potter <me@bpmct.net>
@bpmct bpmct requested a review from jsjoeio September 13, 2021 16:20
@jsjoeio jsjoeio self-assigned this Sep 13, 2021
@jsjoeio jsjoeio added the docs Documentation related label Sep 13, 2021
@jsjoeio jsjoeio added this to the 3.12.0 milestone Sep 13, 2021
Copy link
Contributor

@jsjoeio jsjoeio left a comment

Choose a reason for hiding this comment

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

This all looks great to me! Nice work @galesky - thanks for doing this 🙌 Excited to get users trying Duckly.

Let's get @BrunoQuaresma to help us with the icon and then I will merge this.

@jsjoeio jsjoeio merged commit a0f82f7 into coder:main Sep 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs around using duckly for collaboration
4 participants