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

DOCS-1533 - Updated README in Markdown #149

Merged
merged 17 commits into from
Aug 22, 2022

Conversation

ddl-lgaddie
Copy link
Contributor

@ddl-lgaddie ddl-lgaddie commented Aug 22, 2022

Link to JIRA

DOCS-1533

What issue does this pull request solve?

This PR replaces #146

What is the solution?

Instead of Asciidoc, the canonical README will be in Markdown, then converted to Asciidoc at build time.

Testing

Briefly describe how the change was tested. The purpose of this section is that a reviewer can identify a test gap, if any.

e.g. "I ran an upgrade from 4.2 to 4.6".

  • Unit test(s)

Pull Request Reminders

References (optional)

@ddl-lgaddie ddl-lgaddie requested review from ddl-olsonJD and a team August 22, 2022 20:27
@ddl-olsonJD ddl-olsonJD changed the base branch from master to release-1.1.0 August 22, 2022 21:17
@ddl-olsonJD ddl-olsonJD merged commit dfcedc3 into release-1.1.0 Aug 22, 2022
ddl-olsonJD added a commit that referenced this pull request Aug 22, 2022
* RM-1594 - updated python version to 1.1.0

* RM-1594 - updated version file

* DOCS-1533 - Updated README in Markdown (#149)

* Convert from markdown to Asciidoc

* Oops, add the new file.

* Copyediting and formatting.

* Give code blocks source types

* Minor formatting and editing.

* Update the API docs links, add subheadings to the Methods section, and add new methods for tagging projects.

* Feedback from @ddl-olsonJD

* Minor formatting

* Formatting.

* DOCS-1533 - Updated * and _ usage, and some rewording (#148)

* Add links to code examples.

* Update the version to 1.1.0.

* Convert the updated README back to Markdown from Asciidoc.

* DOCS-1533 - updated changelog

Co-authored-by: ddl-olsonJD <105082373+ddl-olsonJD@users.noreply.github.com>
Co-authored-by: Olson J Dimanche <olson.dimanche@dominodatalab.com>

Co-authored-by: Laurel Gaddie <89212537+ddl-lgaddie@users.noreply.github.com>
ddl-olsonJD added a commit that referenced this pull request Aug 23, 2022
* RM-1594 - updated python version to 1.1.0

* RM-1594 - updated version file

* DOCS-1533 - Updated README in Markdown (#149)

* Convert from markdown to Asciidoc

* Oops, add the new file.

* Copyediting and formatting.

* Give code blocks source types

* Minor formatting and editing.

* Update the API docs links, add subheadings to the Methods section, and add new methods for tagging projects.

* Feedback from @ddl-olsonJD

* Minor formatting

* Formatting.

* DOCS-1533 - Updated * and _ usage, and some rewording (#148)

* Add links to code examples.

* Update the version to 1.1.0.

* Convert the updated README back to Markdown from Asciidoc.

* DOCS-1533 - updated changelog

Co-authored-by: ddl-olsonJD <105082373+ddl-olsonJD@users.noreply.github.com>
Co-authored-by: Olson J Dimanche <olson.dimanche@dominodatalab.com>

* RM-1594 - updated dependency

* RM-1594 - updated dependency

* RM-1594 - updated dependencies and versioning

Co-authored-by: Laurel Gaddie <89212537+ddl-lgaddie@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants