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] Remove broken link to a draft "setting-up-your-editor" blog-entry #7310

Merged
merged 2 commits into from
Apr 16, 2022
Merged

Conversation

Jan-Koll
Copy link
Contributor

With commit bbef991 this blog-entry was marked as a draft, which prevents the page from getting rendered in the svelte-blog. However, over time many contributors added the missing content. Since some pages, e.g. chapter 1: "Making an app" from the tutorial, references to this page, there is a broken link.
This commit removes the draft-marking which should make the page visible and thus fix the broken links.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with [feat], [fix], [chore], or [docs].
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with npm test and lint the project with npm run lint

@benmccann
Copy link
Member

This post will walk you through setting up your editor so that recognises Svelte files:

The first sentence doesn't make sense. I think it should be "so that it"

@Jan-Koll
Copy link
Contributor Author

Oh, you're right. I added the missing word with 5407fce

@benmccann
Copy link
Member

I think the Vim section should mention vim-svelte as well since that extension has twice as many stars: https://github.com/evanleck/vim-svelte

The Sublime section should mention https://packagecontrol.io/packages/Svelte

It might be worth mentioning Emacs as well: https://github.com/fxbois/web-mode

And then at the top I'd add a link for the extensions directory: https://sveltesociety.dev/tools/#editor-support

@dummdidumm
Copy link
Member

Part of this is mentioned in the FAQ. In general, this feels more like a good thing to have in the docs (not the current single-page-docs, but in a future with multiple-page-docs), and not something in a blog post. But I understand that there's value in having this somewhere right now. What are the places where it is linked to? Maybe we can remove the link and add what's missing to the place where it's linked instead. In the example of "Making an app" it's pretty easy as everything except the "treat .svelte files as .html files" section is already mentioned in the tutorial.

@Conduitry
Copy link
Member

This is linked to from the tutorial. I agree that a blog post is not the best place for this information. I think this was a stop-gap way to have this documentation on the site, but then it lived on for years there without receiving much love. I know I have differing opinions from Rich about whether blog posts are a good place to put more guide-y type information that you expect to change over time, so he may feel otherwise. But I would personally be in favor of removing the link(s) to this draft blog post, and revisiting this once we have a multi-page docs site, and once we can freshen up some of the information in this post and move it to a proper home.

@benmccann
Copy link
Member

I had debated between the two and would be fine with that option as well

@rgossiaux
Copy link
Contributor

Just a quick note that I'm happy to help with the neovim section of this, when it comes time to update & publish this info. The neovim ecosystem in general has changed a lot in the 3 years since this was written & it's pretty out of date now. Svelte filetype detection was merged into vim & neovim last year, many people now use neovim's LSP client instead of coc, and many people use treesitter for syntax highlighting now.

@tanhauhau
Copy link
Member

tanhauhau commented Apr 16, 2022

Since @benmccann is okay with either options, and i see @dummdidumm and @Conduitry has stronger feelings that this shouldnt be a blogpost,

I've reverted back to draft for now, and commented out the link from the tutorial to the blogpost itself.
will revisit the content for "setting up your editor" until we have a better doc setup.

@tanhauhau tanhauhau merged commit 09b5afc into sveltejs:master Apr 16, 2022
@tanhauhau tanhauhau changed the title [docs] Remove draft status of setting-up-your-editor blog-entry to fix broken link [docs] Remove broken link to a draft "setting-up-your-editor" blog-entry Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants