Skip to content

Move relevant content from the forge #133

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

Closed
4 of 9 tasks
mark-i-m opened this issue May 14, 2018 · 21 comments · Fixed by #535
Closed
4 of 9 tasks

Move relevant content from the forge #133

mark-i-m opened this issue May 14, 2018 · 21 comments · Fixed by #535
Labels
E-easy Difficulty: might be a good place for a beginner E-help-wanted Call for participation: extra help is wanted

Comments

@mark-i-m
Copy link
Member

mark-i-m commented May 14, 2018

Currently, the forge has a lot of useful content that could be moved over.

It would be good to move each of these over to the relevant part of the rustc guide and delete the corresponding forge page (by making a PR on https://github.com/rust-lang-nursery/rust-forge).

EDIT: according to #133 (comment)

@mark-i-m mark-i-m added E-help-wanted Call for participation: extra help is wanted E-easy Difficulty: might be a good place for a beginner labels May 14, 2018
@benbrandt
Copy link

benbrandt commented Oct 7, 2018

Is this still needed? I'd be happy to help with this with some pointers!

@mark-i-m
Copy link
Member Author

Sorry for the late reply. Yep, this is still needed.

I would suggest picking one of the documents above and making a PR to move it over. Just let me know which one you are interested in. Feel free to ask questions :)

@mark-i-m
Copy link
Member Author

Before you put a lot of work into one of the documents, I would recommend doing a quick search through the book to make sure the topic is not already documented, though.

@pietroalbini
Copy link
Member

About the infra & backporting pages, I think those should be kept on the forge: those are used mostly by the infra/release teams, not by rustc contributors.

@rajcspsg
Copy link
Contributor

@mark-i-m can I work on Stabilization guide (3rd one)?

@pietroalbini
Copy link
Member

@rajcspsg about the stabilization guide, there is additional content in a forge PR.

@mark-i-m
Copy link
Member Author

@rajcspsg That would be great :)

How about a new chapter after the closing conventions chapter?

@rajcspsg
Copy link
Contributor

rajcspsg commented Oct 25, 2018

@mark-i-m could you please provide me more details on conventions chapter (i..e, which pointer in the description)?

@mark-i-m
Copy link
Member Author

@rajcspsg I was thinking of something like this:

  # Summary

  - [About this guide](./about-this-guide.md)
  - [About the compiler team](./compiler-team.md)
  - [How to build the compiler and run what you built](./how-to-build-and-run.md)
      - [Build and Install distribution artifacts](./build-install-distribution-artifacts.md)
      - [Documenting Compiler](./compiler-documenting.md)
  - [Coding conventions](./conventions.md)
+ - [Stabilizing Features](./stabilization.md)
  - [Walkthrough: a typical contribution](./walkthrough.md)
  - [The compiler testing framework](./tests/intro.md)
  - [The compiler testing framework](./tests/intro.md)

Does that answer your question?

@rajcspsg
Copy link
Contributor

Yeah. I got it now :)
Thanks @mark-i-m @pietroalbini
I will go through the documentation and let you know if I have any questions.

@rajcspsg
Copy link
Contributor

@mark-i-m Can I take Implementing new features part of this issue?

@mark-i-m
Copy link
Member Author

@rajcspsg Sounds good 👍

@mark-i-m
Copy link
Member Author

@rajcspsg I also forgot about #98. Do you mind also adding the things Niko mentions in that issue as part of your PR?

@rajcspsg
Copy link
Contributor

@mark-i-m Sure I will do that !!!

@rajcspsg
Copy link
Contributor

@mark-i-m can I work on Compiler Bug Fix Procedure(5th in the list) ?

@mark-i-m
Copy link
Member Author

cc @spastorino @nikomatsakis

@rajcspsg I think there are some ongoing discussions about changing the role of the forge, but I am out of town this week so I don’t know what was decided. Perhaps @spastorino can advise?

@spastorino
Copy link
Member

The idea is that forge should be linked from Rust website and be mainly about procedures. rustc-guide should be pretty focused on "what you need to hack on rustc".

@rajcspsg if you're interested in contributing to rustc-guide in general, I'd recommend you to join Zulip and visit this stream https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning

@mark-i-m
Copy link
Member Author

mark-i-m commented Jun 3, 2019

@spastorino It seems like the 3 remaining topics in the OP checklist are still relevant and should be moved to the guide. Do you agree?

@spastorino
Copy link
Member

@mark-i-m yes 👍, do you want to create issues for them?. I'm planning on starting one or more Project to track some things in a different way but from Project I can link to all these issues we are talking about.

@mark-i-m
Copy link
Member Author

@spastorino I guess I'm not sure. Do we want to make the issues that fine-grained? I'm wary of having information in too many places, as it will be hard to keep everything up to date.

@spastorino
Copy link
Member

@mark-i-m I think you're right. I'd leave the checklist as is in this issue and not open more issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Difficulty: might be a good place for a beginner E-help-wanted Call for participation: extra help is wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants