Skip to content

Commit a4e1146

Browse files
authored
Merge pull request #120 from Frederik-Baetens/prep_shiny_future
prep for shiny future
2 parents 6c50ded + 798e1d5 commit a4e1146

File tree

5 files changed

+46
-10
lines changed

5 files changed

+46
-10
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: '"Shiny future" story issue'
3+
about: Propose a "shiny future" story idea or look for someone to write it
4+
title: ''
5+
labels: good first issue, help wanted, shiny-vision-story-ideas
6+
assignees: ''
7+
8+
---
9+
10+
### Brief summary
11+
12+
*Give a brief summary of the story or vision here*
13+
14+
### Optional details
15+
16+
* (Optional) Which [character(s)] would be the best fit and why?
17+
* [ ] [Alan]: the experienced "GC'd language" developer, new to Rust
18+
* [ ] [Grace]: the systems programming expert, new to Rust
19+
* [ ] [Niklaus]: new programmer from an unconventional background
20+
* [ ] [Barbara]: the experienced Rust developer
21+
* (Optional) Which [project(s)] would be the best fit and why?
22+
* *List some projects here.*
23+
* (Optional) What are the key points or morals to emphasize?
24+
* *Write some morals here.*
25+
26+
[character(s)]: https://rust-lang.github.io/wg-async-foundations/vision/characters.html
27+
[project(s)]: https://rust-lang.github.io/wg-async-foundations/vision/projects.html
28+
[Alan]: https://rust-lang.github.io/wg-async-foundations/vision/characters/alan.html
29+
[Grace]: https://rust-lang.github.io/wg-async-foundations/vision/characters/grace.html
30+
[Niklaus]: https://rust-lang.github.io/wg-async-foundations/vision/characters/niklaus.html
31+
[Barbara]: https://rust-lang.github.io/wg-async-foundations/vision/characters/barbara.html

src/vision/how_to_vision.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| --- | --- |
77
|**Now** till 2021-04-30 | Improve the [sample projects][hvp] |
88
|**Now** till 2021-04-30 | Propose new ["status quo" stories][hvsq] or [comment] on existing PRs |
9-
| 🛑 Starting 2021-04-02 | Propose new ["shiny future" stories][hvsf] or [comment] on existing PRs |
9+
| **Now** till 2021-04-30 | Propose new ["shiny future" stories][hvsf] or [comment] on existing PRs |
1010
| 🛑 Starting 2021-04-30 | Vote for the [awards] on the status quo and shiny future stories! |
1111

1212
## The big picture
@@ -21,7 +21,7 @@ Once the brainstorming period is complete, the working group leads will begin wo
2121

2222
The brainstorming period runs until 2021-04-30:
2323

24-
* Folks open "status quo" and (starting 2021-04-02) "shiny future" story PRs against the [wg-async-foundations repo][repo].
24+
* Folks open "status quo" and "shiny future" story PRs against the [wg-async-foundations repo][repo].
2525
* [Templates and instructions for status quo stories can be found here.][hvsq]
2626
* You can also browse the [open "status quo" issues] for ideas!
2727
* [Templates and instructions for shiny future stories can be found here.][hvsf]

src/vision/how_to_vision/shiny_future.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# ❓ How to vision: "Shiny future" stories
22

3-
## 🛑 Not time for this yet 🛑
4-
5-
We're not ready for this yet! See the [how to vision](../how_to_vision.md) page for details on the phasing.
3+
We want all Async Rust users and their hopes and dreams for what Async Rust should be in the future to be reflected in the async vision doc, so please help us by writing 'shiny future' stories about what you would like async Rust to look like! **Remember: we are in a brainstorming period.** Please feel free to leave comments in an effort to help someone improve their PRs, but if you would prefer a different approach, you are better off writing your own story. (In fact, you should write your own story even if you like their approach but just have a few alternatives that are worth thinking over.)
64

75
[character]: ../characters.md
86
[comment]: ./comment.md

src/vision/shiny_future.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# ✨ Shiny future: Where we want to get to
22

3-
### 🛑 Not time for this yet 🛑
3+
## 🚧 Under construction! Help needed! 🚧
44

5-
We're not really ready to work on this section yet. We're still focused on writing out the [status quo](./status_quo.md).
5+
We are still in the process of drafting the vision document. The stories you see on this page are examples meant to give a feeling for how a shiny future story looks; you can expect them to change. We encourage you to propose your own by opening a PR -- see the ["How to vision"][htv] page for instructions and details.
6+
7+
[htv]: ./how_to_vision.md
68

79
## What it this
810

@@ -18,4 +20,4 @@ We fully expect that the designs and stories described in this document will cha
1820

1921
## Where are the stories?
2022

21-
We haven't written these yet!
23+
We haven't written these yet!

src/vision/shiny_future/template.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,12 @@
1212
[`shiny_future`]: https://github.com/rust-lang/wg-async-foundations/tree/master/src/vision/shiny_future
1313
[`SUMMARY.md`]: https://github.com/rust-lang/wg-async-foundations/blob/master/src/SUMMARY.md
1414

15-
### 🛑 Not time for this yet 🛑
1615

17-
We are not yet accepting shiny future story ideas!
16+
## 🚧 Warning: Draft status 🚧
17+
18+
This is a draft "shiny future" story submitted as part of the brainstorming period. It is derived from what actual Rust users wish async Rust should be, and is meant to deal with some of the challenges that Async Rust programmers face today.
19+
20+
If you would like to expand on this story, or adjust the answers to the FAQ, feel free to open a PR making edits (but keep in mind that, as peoples needs and desires for async Rust may differ greatly, shiny future stories [cannot be wrong]. At worst they are only useful for a small set of people or their problems might be better solved with alternative solutions). Alternatively, you may wish to [add your own shiny vision story][htvsq]!
1821

1922
## The story
2023

@@ -60,3 +63,5 @@ We are not yet accepting shiny future story ideas!
6063
[Niklaus]: ../characters/niklaus.md
6164
[Barbara]: ../characters/barbara.md
6265
[projects]: ../projects.md
66+
[htvsq]: ../how_to_vision/shiny_future.md
67+
[cannot be wrong]: ../how_to_vision/comment.md#comment-to-understand-or-improve-not-to-negate-or-dissuade

0 commit comments

Comments
 (0)