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: split files into subfolders #2257

Merged
merged 2 commits into from
May 13, 2022

Conversation

Exirel
Copy link
Contributor

@Exirel Exirel commented Feb 18, 2022

Description

Tin.

This is only a "first step" to reorganize the documentation around better chapters, and to rationalize where we put code references (i.e. documentation from docstrings).

I didn't change any text, it's really just moving things around.

This was initially based on #2237, #2226, and #2232, until they got merged.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
  • I have tested the functionality of the things this change touches

@Exirel Exirel added Documentation Housekeeping Code cleanup, removal of deprecated stuff, etc. labels Feb 18, 2022
@Exirel Exirel added this to the 8.0.0 milestone Feb 18, 2022
@Exirel Exirel force-pushed the docs-reorganize-packages branch 2 times, most recently from 3541f10 to c9c3729 Compare February 24, 2022 17:54
@Exirel Exirel marked this pull request as ready for review February 24, 2022 18:00
@dgw
Copy link
Member

dgw commented Feb 24, 2022

In lieu of a full review, which I don't really have the steam/spoons/whatever for at this moment, I would like to request that you create a patch for sopel.chat's _redirects file that will direct requests for the deleted/moved pages to the correct new locations. Not necessarily immediately, but before this is merged. :)

@dgw dgw self-requested a review February 24, 2022 18:11
@Exirel
Copy link
Contributor Author

Exirel commented Feb 24, 2022

I would like to request that you create a patch for sopel.chat's _redirects file

That's fair, I'll see it done.

@Exirel Exirel changed the title docs: splits files into subfolders docs: split files into subfolders Feb 24, 2022
Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

Found some spoons. Didn't actually find that much to say, though. 😁

docs/source/package/irc/backends.rst Outdated Show resolved Hide resolved
docs/source/package/loader.rst Outdated Show resolved Hide resolved
docs/source/package/plugins.rst Outdated Show resolved Hide resolved
docs/source/package/tools.rst Outdated Show resolved Hide resolved
docs/source/tests/pytest.rst Outdated Show resolved Hide resolved
@Exirel
Copy link
Contributor Author

Exirel commented Mar 17, 2022

I'll see it done.

But not yet, apparently.

Exirel added a commit to Exirel/sopel.chat that referenced this pull request May 2, 2022
This is related to PR2257 of sopel-irc/sopel repo.

See also: sopel-irc/sopel#2257
@Exirel
Copy link
Contributor Author

Exirel commented May 2, 2022

But not yet, apparently.

And now it is done! See sopel-irc/sopel.chat#38 for more information.

@Exirel
Copy link
Contributor Author

Exirel commented May 2, 2022

@dgw you can review now! And remember, this is only a first step. There are so much more to come in term of documentation!

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

While I haven't actually gone back over this again line-by-line, I'm aware that there will be more documentation patches coming before 8.0. There will be plenty of time to add/fix more stuff.

If nothing else, approving this means you can start on the next phase (new branch based on this one). The only thing I ask for now is to address _redirects in sopel-irc/sopel.chat#38 (patch and/or comment). 😸

Exirel and others added 2 commits May 12, 2022 15:24
* split and replace package/api.rst
* split package/irc.rst
* minor adaptation of package's bot.rst and irc.rst
* split package/config.rst
* split tests.rst
* move and split plugin/internals.rst

And thanks dgw for the code review.

Co-authored-by: dgw <dgw@technobabbl.es>
@dgw
Copy link
Member

dgw commented May 13, 2022

I'm gonna trust GitHub when it says I've still "viewed" all the changed files, and therefore trust that the diff is the same as what was approved. Rebasing pulled in way too many changes from the base branch for me to sort through those. 😅

(Yes, I still wish you wouldn't rebase "just because", when there's no merge conflict, @Exirel. And if you insist, please remember to update your remotes first… The apparent new base commit, 8b463a0, is old! 😝)

@dgw dgw merged commit cea42e1 into sopel-irc:master May 13, 2022
@Exirel
Copy link
Contributor Author

Exirel commented May 13, 2022

I didn't rebase on the last version of master, IIRC, but I have to if I want to squash commits, don't I?

@dgw
Copy link
Member

dgw commented May 13, 2022

You don't have to rebase onto any particular commit, but it's likely that you'll get "the last common commit between this branch and master" by starting your rebase with git rebase -i `git merge-base HEAD master` (note backticks; this is for Bash).

At least, I tried that on one of my somewhat stale topic branches and it started a rebase against the expected commit. YMMV as with most one-liners. There is a --fork-point flag for merge-base that may or may not affect the result, depending on exactly what the branches look like (but for how we usually use topic branches, probably doesn't matter).

@Exirel Exirel deleted the docs-reorganize-packages branch June 12, 2022 06:34
dgw pushed a commit to sopel-irc/sopel.chat that referenced this pull request May 27, 2024
This is related to PR2257 of sopel-irc/sopel repo.

See also: sopel-irc/sopel#2257
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Housekeeping Code cleanup, removal of deprecated stuff, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants