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

Increases clarity in staging process. #1698

Merged
merged 3 commits into from
May 25, 2022

Conversation

shloka-gupta
Copy link
Contributor

PR Checklist:

  • make all edits to the docs in the src directory, not in docs or in the html files
  • note any issues closed by this PR with closing keywords
  • put any other relevant information below

This PR hopes to increase clarity for a reader by:

  • Adding the steps that are there in the staging process. So that the person hopefully doesn't skip them.
  • Adding paths so that it is simplified for the reader.
  • Modifying the words a little.

@shloka-gupta shloka-gupta requested a review from a team as a code owner April 9, 2022 00:35
@shloka-gupta
Copy link
Contributor Author

shloka-gupta commented Apr 9, 2022

Hi,
This PR hopes to increase clarity for the reader.

A thing that I have observed is that:

As a reader for 'getting started' I kept jumping from link to link without completely reading all the instructions.

For example: the sentence - Look at the example recipe in the staged-recipes repository`
That's the first instruction I read. I clicked on the link and I thought to myself-- "Okay. Now what?"

And I am assuming there are many readers like me (more experienced ofc!) who fall into a pile of mishaps they could have avoided if only they had read all the instructions.

A possible solution:

Shall we put up the instructions on going around Grayskull, CRAN (Not my forte!), and the example recipe within this document itself?
To neaten things up we could make use of sphinx tabs.

@shloka-gupta
Copy link
Contributor Author

@kathatherine @beckermr @BastianZim do you think it's a good idea to do so?

@kathatherine
Copy link
Contributor

@chicken-biryani I love sphinx tabs. Anaconda, where I work, is thinking of adding that to our own docs. Please write up an example of what you're thinking and I'd love to look at it. Anything that can increase clarity for the user and keep them from wandering away from the documentation flow is a good idea to me.

src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
@shloka-gupta
Copy link
Contributor Author

shloka-gupta commented Apr 14, 2022

@kathatherine
Fixed it.
(i.e... ) does seem to be a better approach.

Please write up an example of what you're thinking

I'll create a separate draft PR for that? It may get a little messy but I think it's worth a shot.

Co-authored-by: Jaime Rodríguez-Guerra <jaimergp@users.noreply.github.com>
@kathatherine
Copy link
Contributor

@chicken-biryani Yes, a separate PR would probably be the way to go. Maybe even an entirely separate issue?

@shloka-gupta
Copy link
Contributor Author

@kathatherine on it!

Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

This looks good to me!

@jakirkham
Copy link
Member

Powercycling for CI

@jakirkham jakirkham closed this May 25, 2022
@jakirkham jakirkham reopened this May 25, 2022
@jakirkham jakirkham enabled auto-merge May 25, 2022 05:33
@jakirkham jakirkham merged commit 1da8950 into conda-forge:main May 25, 2022
@shloka-gupta
Copy link
Contributor Author

Hi,

I am clubbing my ideas for the adding packages into a single PR over here:

#1755

Will wind up the work asap!

@jakirkham
Copy link
Member

Ah ok. Was trying to triage and get in PRs that seemed ready to merge

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

Successfully merging this pull request may close these issues.

None yet

4 participants