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

Make a Doc continuity pass for 0.7 #275

Merged
merged 2 commits into from
May 28, 2019
Merged

Conversation

Lnaden
Copy link
Collaborator

@Lnaden Lnaden commented May 27, 2019

I've gone though and touched many of the pages to keep the docs in line
with one another as far as features, content, and references. I'm sure
there are plenty of missed items, but I think this will be a good step.

I also updated the devtools README.md file to be accurate to the
folder contents and how we go about things.

Status

  • Changelog updated
  • Ready to go

I've gone though and touched many of the pages to keep the docs in line
with one another as far as features, content, and references. I'm sure
there are plenty of missed items, but I think this will be a good step.

I also updated the `devtools` README.md file to be accurate to the
folder contents and how we go about things.
@Lnaden Lnaden added the Documentation Unclear or incorrect documentation label May 27, 2019
@Lnaden Lnaden added this to the v0.7.0 milestone May 27, 2019
@Lnaden Lnaden requested a review from dgasmith May 27, 2019 16:32
@codecov
Copy link

codecov bot commented May 27, 2019

Codecov Report

Merging #275 into master will not change coverage.
The diff coverage is n/a.

**0.7.0 is the last major release which support MongoDB.** Fractal is moving towards a PostgreSQL for database to
make upgrades more stable and because it is more suited to the nature of QCArchive Data. The upgrade path for
MongoDB -> PostgreSQL will be provided by the Fractal developers in the next release. This first one will likely
be a bit manual in th form of scripts, but afterwords will be engineered to be more automatic and documented.
Copy link
Contributor

Choose a reason for hiding this comment

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

Spelling, and professional tone.

The above command installs qcfractal and its required dependencies, but *not* any of the quantum
chemistry codes nor the software to run :term:`Queue Managers <Manager>`. This is done to avoid
requiring *every* software which *can* interface with Fractal, and instead leaving it up to the
user to get the software they *want*.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is done to avoid requiring *all* software which *can* interface with Fractal, and instead requires the user to obtain the software they *require*.

@dgasmith dgasmith merged commit 169cb2e into MolSSI:master May 28, 2019
@Lnaden Lnaden deleted the 07fulldocpass branch June 6, 2019 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Unclear or incorrect documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants