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.

Sign up for GitHub

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

Jump to bottom

Add Tools page #679

Merged
merged 4 commits into from
Jun 8, 2024
Merged

Add Tools page #679

merged 4 commits into from
Jun 8, 2024

Conversation

federicobucchi
Copy link
Contributor

@federicobucchi federicobucchi commented May 28, 2024 •
edited
Loading

Motivation:

We need to add a page that will list Tools (for the first phase only Editors) supported by Swift.

Modifications:

  • Add a new route called Tools
  • Added HTML and CSS for the page
  • Added editors.yml that will list the editors info

Result:

Screenshot 2024-05-31 at 10 59 51 AM

@federicobucchi federicobucchi force-pushed the fb/add-tools-page branch 2 times, most recently from a9a2a6a to fccdfa0 Compare May 31, 2024 18:01
bnbarham
bnbarham reviewed Jun 3, 2024
View reviewed changes
Copy link

@bnbarham bnbarham left a comment

Choose a reason for hiding this comment

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

Added some descriptions to iterate on. Not sure what to fill in for the "which provides <...>" part of VS Code - this is semantic functionality/code completion/jump to definition/find references/etc, but I can't find a generally accepted term for them all. I called it "Swift editing support" for Vim/Emacs.

tools/_editors.md Outdated Show resolved Hide resolved
_data/tools/editors.yml Outdated Show resolved Hide resolved
_data/tools/editors.yml Outdated Show resolved Hide resolved
_data/tools/editors.yml Outdated Show resolved Hide resolved
_data/tools/editors.yml Outdated Show resolved Hide resolved
tools/index.md Outdated Show resolved Hide resolved
ahoppen
ahoppen reviewed Jun 3, 2024
View reviewed changes
_data/tools/editors.yml Outdated Show resolved Hide resolved
bnbarham
bnbarham reviewed Jun 4, 2024
View reviewed changes
_data/tools/editors.yml Outdated Show resolved Hide resolved
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
333a6e9 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
bd7eedd 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
f6574d9 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
3eaac04 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
@ahoppen ahoppen mentioned this pull request Jun 4, 2024
Merged
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
a66506c 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
@federicobucchi federicobucchi marked this pull request as ready for review June 4, 2024 04:32
ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
30acbe8 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
0xTim
0xTim reviewed Jun 4, 2024
View reviewed changes
Copy link
Member

@0xTim 0xTim left a comment

Choose a reason for hiding this comment

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

LGTM - no major concerns after the meeting. The only thing I might tweak is the description of the LSP section

@federicobucchi
Copy link
Contributor Author

Screenshot 2024-06-04 at 2 35 45 PM

@bnbarham
Copy link

bnbarham commented Jun 4, 2024

The last bit of feedback was to also add a "Learn More" to the Xcode section, just linking to the same as "Xcode" itself - otherwise it looks a bit out of balance.

@federicobucchi
Copy link
Contributor Author

The last bit of feedback was to also add a "Learn More" to the Xcode section, just linking to the same as "Xcode" itself - otherwise it looks a bit out of balance.

Is there another link we can use? I want to avoid to send the user in the same place with 2 close links

@bnbarham
Copy link

bnbarham commented Jun 4, 2024

Is there another link we can use? I want to avoid to send the user in the same place with 2 close links

Not that I know of. TBH I'm not sure the title being a link is all that obvious anyway, so I'd say it's probably fine.

@federicobucchi
Copy link
Contributor Author

Screenshot 2024-06-04 at 2 57 45 PM

ahoppen added a commit to ahoppen/sourcekit-lsp that referenced this pull request Jun 4, 2024
@ahoppen
Improve markdown files
b332f3d 
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
ahoppen
ahoppen reviewed Jun 4, 2024
View reviewed changes
_data/tools/editors.yml Outdated Show resolved Hide resolved
alexandersandberg
alexandersandberg approved these changes Jun 5, 2024
View reviewed changes
Copy link
Member

@alexandersandberg alexandersandberg left a comment

Choose a reason for hiding this comment

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

Small copy nit, otherwise looks good!

_data/tools/editors.yml Outdated Show resolved Hide resolved
@federicobucchi federicobucchi requested a review from 0xTim June 5, 2024 05:25
@0xTim
Copy link
Member

0xTim commented Jun 5, 2024

@swift-ci please test

@federicobucchi
Copy link
Contributor Author

This PR is blocked by:

@kristoferfannar kristoferfannar mentioned this pull request Jun 6, 2024
Closed
@federicobucchi
Copy link
Contributor Author

@swift-ci please test

@federicobucchi federicobucchi merged commit 7f655d0 into main Jun 8, 2024
1 check passed
@federicobucchi federicobucchi deleted the fb/add-tools-page branch June 8, 2024 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahoppen ahoppen ahoppen approved these changes

@bnbarham bnbarham bnbarham approved these changes

@0xTim 0xTim 0xTim approved these changes

@alexandersandberg alexandersandberg alexandersandberg approved these changes

@daveverwer daveverwer Awaiting requested review from daveverwer daveverwer is a code owner

@dempseyatgithub dempseyatgithub Awaiting requested review from dempseyatgithub dempseyatgithub is a code owner

@parispittman parispittman Awaiting requested review from parispittman parispittman is a code owner

@kaishin kaishin Awaiting requested review from kaishin kaishin is a code owner

@shahmishal shahmishal Awaiting requested review from shahmishal shahmishal is a code owner

@cthielen cthielen Awaiting requested review from cthielen

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@federicobucchi @bnbarham @0xTim @ahoppen @alexandersandberg