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

promoted documentation on working with DataFrames #2700

Merged
merged 9 commits into from
Apr 4, 2021
Merged

promoted documentation on working with DataFrames #2700

merged 9 commits into from
Apr 4, 2021

Conversation

RohitRathore1
Copy link
Contributor

@RohitRathore1 RohitRathore1 commented Apr 3, 2021

It resolves issue #2623 where our aim was to promote documentation on working with DataFrames as the sub-sub section of working with DataFrames was not appearing in the left menu navigation.

@bkamins bkamins linked an issue Apr 3, 2021 that may be closed by this pull request
@bkamins
Copy link
Member

bkamins commented Apr 3, 2021

OK - we can make this change (though this part of the manual is likely to get replaced soon by the new manual - right?).

If we go for it then also the sections on "Replacing data" and "Importing and Exporting Data (I/O)" should be moved to this separate file (as now you have extracted one section in the middle of the manual and applying this change would change the order in which the user would read it).

@bkamins bkamins added the doc label Apr 3, 2021
@bkamins bkamins added this to the 1.0 milestone Apr 3, 2021
@bkamins bkamins mentioned this pull request Apr 3, 2021
@RohitRathore1
Copy link
Contributor Author

OK - we can make this change (though this part of the manual is likely to get replaced soon by the new manual - right?).
Yeah, but for now it was solving the current open issue.
If we go for it then also the sections on "Replacing data" and "Importing and Exporting Data (I/O)" should be moved to this separate file (as now you have extracted one section in the middle of the manual and applying this change would change the order in which the user would read it).
Hmm, i am adding some commits.

@RohitRathore1
Copy link
Contributor Author

Because of typo error in file name building was failing. So fixed it

@bkamins
Copy link
Member

bkamins commented Apr 3, 2021

Because of typo error in file name building was failing. So fixed it

As commented on Slack - please make sure that before you push a PR to GitHub you are able to build the documentation locally and all looks good.

@RohitRathore1
Copy link
Contributor Author

Because of typo error in file name building was failing. So fixed it

As commented on Slack - please make sure that before you push a PR to GitHub you are able to build the documentation locally and all looks good.

yes, I am following this now.

docs/make.jl Outdated
@@ -22,6 +22,9 @@ makedocs(
"Introduction" => "index.md",
"User Guide" => Any[
"Getting Started" => "man/getting_started.md",
"Working with DataFrames" => "man/Working_with_DataFrames.md",
"Replacing Data" => "man/replacing_data.md",
Copy link
Member

Choose a reason for hiding this comment

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

do you feel (as a user) it is worth to promote "Replacing Data" to top level here? Or it is better to have it as a section in "Working with DataFrames"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think so because when a user will review 'Working with DataFrames' then after completing that section he can directly jump to the 'Replacing Data' section in the series. But both things will be fine(show it as a section in 'working with DataFrames' or promote it to the top level).

Copy link
Member

Choose a reason for hiding this comment

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

I would then include "Replacing Data" in "Working with DataFrames"

docs/make.jl Outdated Show resolved Hide resolved
@bkamins bkamins merged commit 436dc70 into JuliaData:main Apr 4, 2021
@bkamins
Copy link
Member

bkamins commented Apr 4, 2021

Thank you!

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

Successfully merging this pull request may close these issues.

Promote Documentation on Working with Data Frames
2 participants