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

[docs] Remove release candidate warnings #8109

Merged
merged 10 commits into from
Dec 14, 2022
Merged

[docs] Remove release candidate warnings #8109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b0b955e
[docs] Remove release candidate warnings
dummdidumm Dec 12, 2022
46f1b20
do->try, remove issue line
dummdidumm Dec 14, 2022
5eec81a
we can trim this riiiiight down
Rich-Harris Dec 14, 2022
9d2184d
Merge branch 'remove-rc-stuff' of github.com:sveltejs/kit into remove…
Rich-Harris Dec 14, 2022
b2e486d
dont point people at the tutorial just yet
Rich-Harris Dec 14, 2022
6c4a2c8
Update README.md
Rich-Harris Dec 14, 2022
5f18b63
tweak intro doc
Rich-Harris Dec 14, 2022
a5a84bd
Merge branch 'remove-rc-stuff' of github.com:sveltejs/kit into remove…
Rich-Harris Dec 14, 2022
55b6fda
tweak
Rich-Harris Dec 14, 2022
61df2eb
Update documentation/docs/10-getting-started/10-introduction.md
Rich-Harris Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/rude-pears-hammer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-svelte': patch
---

[feat] remove release candidate banner
11 changes: 0 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
[![Chat](https://img.shields.io/discord/457912077277855764?label=chat&logo=discord)](https://svelte.dev/chat)

# READ THIS FIRST!

SvelteKit is in its release candidate phase:
- :exclamation: expect bugs!
- :heavy_check_mark: no more planned breaking changes
- :heavy_check_mark: countdown to a stable release
- :x: feature-complete
- :x: tutorials

Watch [the announcement](https://www.youtube.com/watch?v=A8jkJTWacow&t=29628s) and track [progress towards 1.0](https://github.com/sveltejs/kit/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.0) for more details.

## Overview

The Fastest Way to Build Svelte Apps
Expand Down
4 changes: 3 additions & 1 deletion documentation/docs/10-getting-started/10-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ title: Introduction

## Before we begin

> SvelteKit is in release candidate phase for 1.0 while we address reported issues and add polish. If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat).
> If you're new to SvelteKit, do the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> If you're new to SvelteKit, do the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit).
> If you're new to SvelteKit, try the [interactive tutorial](https://learn.svelte.dev/tutorial/introducing-sveltekit).

Copy link
Member Author

@dummdidumm dummdidumm Dec 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Why try over do? (might be my non-native-english me not understanding the subtle difference)

Copy link
Member

Choose a reason for hiding this comment

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

"do" reads slightly awkwardly to me. I'd probably make it something like "complete" if I wanted to make it a command. But it also feels slightly commanding to me whereas "try" is more of a recommendation than a command. It's pretty subtle and probably different people will have different views of it

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 I'll adjust it

>
> If you get stuck, reach out for help in the [Discord chatroom](https://svelte.dev/chat).
>
> See the [migration guides](/docs/migrating) for help upgrading from Sapper.

Expand Down
5 changes: 0 additions & 5 deletions documentation/faq/10-version-numbers.md
View file
Open in desktop

This file was deleted.

14 changes: 9 additions & 5 deletions packages/create-svelte/bin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ import { dist } from './utils.js';
// prettier-ignore
const disclaimer = `
${bold(cyan('Welcome to SvelteKit!'))}

${bold(red('This is release candidate software; expect bugs and missing features.'))}

Problems? Open an issue on ${cyan('https://github.com/sveltejs/kit/issues')} if none exists already.
`;

const { version } = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8'));
Expand Down Expand Up @@ -180,7 +176,15 @@ async function main() {
console.log(` ${i++}: ${bold(cyan('npm run dev -- --open'))}`);

console.log(`\nTo close the dev server, hit ${bold(cyan('Ctrl-C'))}`);
console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}\n`);
console.log(
Copy link
Member

Choose a reason for hiding this comment

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

this seems a bit verbose to include in the CLI. I'd probably just keep this portion how it was before

Copy link
Member Author

Choose a reason for hiding this comment

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

I like that it's three items (a nice number of sentences), each is short, starts with a one-word-question, and serves a different purpose.

Copy link
Member

Choose a reason for hiding this comment

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

I think the one I'm most hesitant about is encouraging people to file issues l. I sort of liked directing people to Discord first because then the community can help us triage a bit whether it's a usage issue or a bug that should be filed

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds good, I'll remove that item.

Copy link
Member

Choose a reason for hiding this comment

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

I'd like the tutorial to be a bit more buttoned up before we start directing people there without caveats. For example if you follow the link here you go to a page that begins

So far, we've been working on individual components, or groups of components, in isolation

which is a major WTF if you land there without context. Let's revert this to how it was before

Copy link
Member

Choose a reason for hiding this comment

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

will push that change, one sec

Copy link
Member Author

Choose a reason for hiding this comment

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

FYI I also mention the tutorial on the intro docs - do you want to remove it from there, too?

Copy link
Member

Choose a reason for hiding this comment

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

i think we can link to it, but with caveats (and probably to the first page, not straight to part 2). i'm going to tweak some other word in there anyway so will do that now

`\nNew? Do the tutorial at ${cyan('https://learn.svelte.dev/tutorial/introducing-sveltekit')}\n`
Rich-Harris marked this conversation as resolved.
Show resolved Hide resolved
);
console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}`);
console.log(
`\nProblems? Open an issue on ${cyan(
'https://github.com/sveltejs/kit/issues'
)} if none exists already.\n`
);
}

main();