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

initializing the how to section #325

Merged
merged 19 commits into from
Sep 27, 2022
Merged

initializing the how to section #325

merged 19 commits into from
Sep 27, 2022

Conversation

droumis
Copy link
Member

@droumis droumis commented Sep 20, 2022

Screenshot 2022-09-22 at 12 42 22

I personally don't think we should subsection the How-to until there is more than a handful of specific pages of content.. otherwise, it just seems like structural bloat.

Reminder about How to section guidelines:

  • Does the title start with ‘how to’ (or at least is the scope specific enough that it could)?
  • Does it describe clearly the problem or task that it aims to solve?
  • Does it exclude teaching and discussion?
  • Does it focus on the step-by-step sequence of actions to solve a specific real-world problem?
  • Does it follow a consistent format?

docs/how_to/ht_validate.md Outdated Show resolved Hide resolved

pipeline.data
```
![data preview](../_static/pipeline_data.png)
Copy link
Member

Choose a reason for hiding this comment

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

Can we remove the screenshots here? I'll add the pyodide rendering extension in a separate PR and then the output will be generated.

Copy link
Member Author

@droumis droumis Sep 27, 2022

Choose a reason for hiding this comment

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

@philippjfr so you want all the screenshots removed across the how to guides, correct?

Copy link
Member

@philippjfr philippjfr Sep 27, 2022

Choose a reason for hiding this comment

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

Just for this how to guide for now I think since it's very simple, for the other one I'm not sure yet so let's leave it for now.

Copy link
Member Author

Choose a reason for hiding this comment

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

done

Now you can apply a `transform` to the data, such as computing the mean or selecting certain columns. See the [Transform Reference](../architecture/transform) for more.

```{code-block} python
:emphasize-lines: 14-15
Copy link
Member

Choose a reason for hiding this comment

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

Will have to see if I can get emphasis working in the pyodide extension so we can have live output here too.

@codecov-commenter
Copy link

codecov-commenter commented Sep 27, 2022

Codecov Report

Merging #325 (c00f2a8) into master (81ce54f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #325   +/-   ##
=======================================
  Coverage   66.75%   66.75%           
=======================================
  Files          71       71           
  Lines        7210     7210           
=======================================
  Hits         4813     4813           
  Misses       2397     2397           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@droumis
Copy link
Member Author

droumis commented Sep 27, 2022

The emphasis does not look great on the dev site.. also, the how-to names overflow on the left nav.. :(
Screen Shot 2022-09-27 at 12 32 15

@philippjfr
Copy link
Member

That's okay, we can make some tweaks to give a little bit more space and make the highlight stand out more in a separate PR.

@droumis droumis marked this pull request as ready for review September 27, 2022 11:23
@philippjfr philippjfr merged commit b3ac852 into master Sep 27, 2022
@philippjfr philippjfr deleted the dr/docs_how-to branch September 27, 2022 11:24
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants