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

Documentation updates for upcoming Eloquent release #310

Merged
merged 4 commits into from
Aug 8, 2019
Merged

Conversation

mjcarroll
Copy link
Member

@mjcarroll mjcarroll commented Aug 6, 2019

  • Add Eloquent release page with timeline
  • Update roadmap
  • Copy installation instructions for Eloquent

The Eloquent release schedule attempts to keep the spacing of the Dashing release, with some slight adjustments for ROSCon. I generally assumed that internal and external contributors will be distracted by travel and the conference, so avoided putting any deadlines in that week.

@maryaB-osr
Copy link
Contributor

Great, we've been discussing putting this up now to be pointed to by the "latest" page, what do you think about that? I was putting together the file structure here, obviously without the content (and I'll just scrap that PR now). The idea is that references to the "latest" developments, if anyone's interested in installing them, will point to the upcoming release. For now that's Eloquent.

All that would mean is adding a note to Installation.rst, under the table, saying something like:

"The next (or upcoming) release is under development. You can install it here"

And link to Latest.rst, which redirects to Eloquent.rst.

That is, if you think it's a good idea to let people install eloquent while it's under development?

@mjcarroll
Copy link
Member Author

That is, if you think it's a good idea to let people install eloquent while it's under development?

I think prior to at least the alpha, the installation instructions are going to be largely for collaborators to make updates about dependencies and Eloquent-specific instructions. We won't have a first round of packages out until after that date. I would suggest that we maybe delay adding the concept of Latest until that point?

@dirk-thomas
Copy link
Member

The Maintaining-a-Source-Checkout doesn't seem to be distro specific at the moment.

This should be merged without squashing at the end (to keep the separate commits for duplicating and changing the Eloquent pages). Before that please squash into a minimal number of commits.

Copy link
Member

@dirk-thomas dirk-thomas left a comment

Choose a reason for hiding this comment

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

lgtm

@dirk-thomas
Copy link
Member

I think prior to at least the alpha, the installation instructions are going to be largely for collaborators to make updates about dependencies and Eloquent-specific instructions. We won't have a first round of packages out until after that date.

Before Debian packages are available the instructions are used for from-source builds as well as can be used to obtain the nightly archives from Jenkins.

I would suggest that we maybe delay adding the concept of Latest until that point?

The concept of "latest" always exists. It is the state on the default branches which will become the upcoming release.

@maryaB-osr
Copy link
Contributor

Before Debian packages are available the instructions are used for from-source builds as well as can be used to obtain the nightly archives from Jenkins.

The instructions for binaries are already linked on the Eloquent installation types page, so if we have latest point to it now that part would have to be changed...

@mjcarroll
Copy link
Member Author

The Maintaining-a-Source-Checkout doesn't seem to be distro specific at the moment.

Yeah, I diffed between Crystal and Dashing and there weren't any changes there. Would you propose moving it up a directory?

@dirk-thomas
Copy link
Member

Would you propose moving it up a directory?

Sure, if it is not distro-specific there is no point in duplicating it.

@mjcarroll
Copy link
Member Author

I reworked this into a minimal number of commits, and consolidated the maintaining a source checkout to only one page.

@@ -1,3 +1,4 @@

Copy link
Member

Choose a reason for hiding this comment

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

Please don't change the file while also moving it. In this case the extra empty line can just be removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed, sorry I missed that.

Copy link
Member

@dirk-thomas dirk-thomas left a comment

Choose a reason for hiding this comment

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

👍 to not-squash merge

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

3 participants