Skip to content

Use updated doc generation commands in Getting Started section #12105

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 0 commits into from
Closed

Use updated doc generation commands in Getting Started section #12105

wants to merge 0 commits into from

Conversation

nogurenn
Copy link
Contributor

@nogurenn nogurenn commented Apr 15, 2021 •
edited
Loading

Fixes #12075

Looks like
image

abgruszecki
abgruszecki reviewed Apr 19, 2021
View reviewed changes
Copy link
Contributor

@abgruszecki abgruszecki left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Some small changes and we can merge it.

docs/docs/contributing/getting-started.md Outdated
$ sbt
> genDocs
> scalaDoc/generateScalaDocumentation
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be scaladoc instead of scalaDoc, no?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, it is scaladoc

docs/docs/contributing/getting-started.md Outdated
> scalaDoc/generateScalaDocumentation

# or run the following bash script to generate docs under $PWD/docs/_site
$ ./project/scripts/genDocs
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd avoid mentioning this script, it seems a bit more internal than the generateScalaDocumentation task.

@nogurenn
Copy link
Contributor Author

nogurenn commented Apr 20, 2021 •
edited
Loading

@abgruszecki @romanowski i think my rebase was wrong. i was expecting to see my changes only. should I just open a new PR from a different branch?

git co master
git pull upstream master
git push
git co amend/gen-doc-get-started
git rebase master

@abgruszecki
Copy link
Contributor

@nogurenn you can always force-push to the branch this PR was opened from, it's fine.

@nogurenn nogurenn closed this Apr 20, 2021
@nogurenn nogurenn force-pushed the amend/gen-doc-get-started branch from eee6462 to 26e3795 Compare April 20, 2021 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@romanowski romanowski romanowski left review comments

@abgruszecki abgruszecki abgruszecki left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

genDocs command not found in Getting Started page
3 participants
@nogurenn @abgruszecki @romanowski