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

Enlight pathways for new contributors #1444

Open
Totktonada opened this issue Aug 6, 2020 · 8 comments
Open

Enlight pathways for new contributors #1444

Totktonada opened this issue Aug 6, 2020 · 8 comments
Assignees

Comments

@Totktonada
Copy link
Member

When I search for "python contribution guide" google land me to https://devguide.python.org/ , where different contribution activities are described:


image


It seems our contribution guides are much less clear for a potential new contributor.

It is the topic to investigation. Say, the documentation team may start with a guide how to contribute to the documentation :)

@tsafin may want to give more thoughts on the topic.

@Totktonada
Copy link
Member Author

The idea comes from @tsafin's talk within the team, so give all credits to him.

@artur-barsegyan
Copy link
Contributor

The idea with the table seems convenient for users' navigation.

Our current guide doesn't contain any navigation table and text for newcomers.

I have written the first draft of this guide with the navigation table. Please see it here.
Waiting for feedback :)

@artur-barsegyan
Copy link
Contributor

The Navigation table was declined by @knazarov because:

  • Markdown tables at Github are horrible
  • Tables aren't appropriate format for our purpose. They are convenient for feature comparisons and for column-similar data.

@Totktonada
Copy link
Member Author

Markdown tables at Github are horrible

I use it from time to time, but I don't remember any problem (for example, here, here, here, here). Can you clarify, please?

Tables aren't appropriate format for our purpose. They are convenient for feature comparisons and for column-similar data.

It is debatable, but personally I don't have strict preference here (at least for now).

@artur-barsegyan
Copy link
Contributor

Hmm, actually tables look OK. But the second bullet is more important — political decision.

@Totktonada
Copy link
Member Author

Re tables: I remember I had some problems with wrapping in a non-last column, but either I'm wrong here or it has been fixed.

Example
x y z
Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible, Markdown tables at Github are NOT horrible

@artur-barsegyan
Copy link
Contributor

Seems like, we choose another way to highlight pathways. Can I close it @Totktonada ?

@Totktonada
Copy link
Member Author

I would not call it 'another way', but rather another formatting and wording: the idea about routing users to relevant guides still remains. Anyway, let's manage issues as it is convenient for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants