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.

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

Docs: More fixes and improvements #2203

Merged
merged 1 commit into from Dec 18, 2022
Merged

Docs: More fixes and improvements #2203

merged 1 commit into from Dec 18, 2022

Conversation

tooomm
Copy link
Contributor

@tooomm tooomm commented Dec 17, 2022 •
edited

Proposed change

As mentioned in an earlier PR, the changelog.md file had many conversion issues which I tried to address here.
Also some small other fixes and improvements.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (please explain): Docs

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@paperless-ngx-secretary paperless-ngx-secretary bot added documentation Improvements or additions to documentation small-change labels Dec 17, 2022
@paperless-ngx-secretary
Copy link

Hello @tooomm,

thank you very much for submitting this PR to us!

This is what will happen next:

  1. My robotic colleagues will check your changes to see if they break anything. You can see the progress below.
  2. Once that is finished, human contributors from paperless-ngx review your changes. Since this seems to be a small change, only a single contributor has to review your changes.
  3. Please improve anything that comes up during the review until your pull request gets approved.
  4. Your pull request will be merged into the dev branch. Changes there will be tested further.
  5. Eventually, changes from you and other contributors will be merged into main and a new release will be made.

Please allow up to 7 days for an initial review. We're all very excited about new pull requests but we only do this as a hobby.
If any action will be required by you, please reply within a month.

shamoon
shamoon requested changes Dec 17, 2022
View reviewed changes
Copy link
Member

@shamoon shamoon left a comment

Choose a reason for hiding this comment

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

Thanks but some of these seem unnecessary like all the changes in index, and why bother removing dependabot links? Those are auto-generated and so the next time we have a release it’ll include them making things inconsistent (though of course I agree they’re pointless). If you wouldn’t mind limiting these PRs to things that are actually broken.

Quality over quantity! 👍

@tooomm
Copy link
Contributor Author

tooomm commented Dec 17, 2022 •
edited

why bother removing dependabot links? Those are auto-generated and so the next time we have a release it’ll include them making things inconsistent (though of course I agree they’re pointless)

Please check https://docs.paperless-ngx.com/changelog, dependabot is no longer linked. It's automatically linked in GH release descriptions still, because of how GitHub threatens @. It can be seen well in your last manual commit: 6938349
I made the changelog uniform and removed old links to the dependabot profile as well.

Edit: Had another look and found some @ that got falsely removed. Not sure why they are placed sometimes by dependabot PR's.

Let me know if you want me to do further changes, shamoon.

@tooomm tooomm changed the title Docs: More fixes Docs: More fixes and improvements Dec 17, 2022
@tooomm @shamoon
doc fixes
43b863b 
This reverts commit e015bab.

link fix

fix escaping, spacing, profile links, typo

revert

~~add~~ at fixes

Revert "~~add~~ at fixes"

This reverts commit ce0192b.
@shamoon
Copy link
Member

shamoon commented Dec 18, 2022

Thanks again tooomm, I pared it back to be just the errors, I think the other stuff can be left alone

@shamoon shamoon merged commit 6f6f365 into paperless-ngx:main Dec 18, 2022
@tooomm
Copy link
Contributor Author

tooomm commented Dec 19, 2022 •
edited

Thanks for bringing this forward and providing feedback @shamoon.

But you need to help me now to better understand how to proceed from here and prevent misalignment in potential future PR's.
I was planning to improve the docs further. Obviously, I prefer to not invest time and effort if I'm missing a point here.

After your change, there are now several errors still live in the changelog page of the documentation besides the mentioned dependabot stuff, e.g.:

  • false links
  • broken mkdocs formatting
  • many leftover layout/styling issues from the conversion

I know that squashing my pile of small commits locally was not perfect and reduced overview while it was actually supposed to achieve the opposite.

@shamoon
Copy link
Member

shamoon commented Dec 19, 2022

Ah, sorry if things got lost. Feel free to fix things that are broken like links and generally things that have actual effects on the docs / people's ability to use them. It looked to me like some of those things were just for "correctness" sake which made it hard to pick out the useful changes, so again sorry if some useful ones were lost 👍

shamoon added a commit that referenced this pull request Dec 30, 2022
@shamoon
Squashed commit of the following:
cd5432f 
commit b1410a8
Merge: f9ce4d8 8ec9c77
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Thu Dec 29 20:09:09 2022 -0800

    Merge pull request #2263 from paperless-ngx/v1.11.0-changelog

    [Documentation] Add v1.11.0 changelog

commit 8ec9c77
Author: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Fri Dec 30 04:08:17 2022 +0000

    Changelog v1.11.0 - GHA

commit f9ce4d8
Author: Michael Shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Thu Dec 29 19:40:25 2022 -0800

    Update version strings for 1.11.0

commit 8c9a74e
Merge: 605f86f 0b59ef2
Author: Michael Shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Thu Dec 29 19:39:38 2022 -0800

    Merge branch 'dev'

commit 605f86f
Merge: 800e842 8cbaca2
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Wed Dec 28 15:55:35 2022 -0800

    Merge pull request #2256 from mendelk/patch-1

    Fixed typo in docs

commit 8cbaca2
Author: Mendel Kramer <mendelk@users.noreply.github.com>
Date:   Wed Dec 28 18:16:00 2022 -0500

    Fixed typo in docs

commit 800e842
Author: ThellraAK <github.com@absurdlybored.com>
Date:   Wed Dec 21 01:36:37 2022 -0900

    Removing Mariadb default open port (#2227)

    * Removing Mariadb default open port

    Removing the listening port 3306 for the DB, Docker networks will let the containers talk to one another.  The existing setup would allow anyone to connect to the DB and use the default passwords.

    * Update docker-compose.mariadb-tika.yml

    Adding change to the other compose file to remove open port

    * Remove excess blank lines

    * Remove excess blank lines

    Co-authored-by: Felix E <felix@eckhofer.com>

commit 6f6f365
Merge: 6d324db 43b863b
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Sat Dec 17 19:58:06 2022 -0800

    Merge pull request #2203 from tooomm/docs_updates

    Docs: More fixes and improvements

commit 43b863b
Author: tooomm <tooomm@users.noreply.github.com>
Date:   Sun Dec 11 19:44:18 2022 +0100

    doc fixes

    This reverts commit e015bab.

    link fix

    fix escaping, spacing, profile links, typo

    revert

    ~~add~~ at fixes

    Revert "~~add~~ at fixes"

    This reverts commit ce0192b.

commit 6d324db
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Fri Dec 16 09:10:11 2022 -0800

    Update config.yml

commit 8ddf05e
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Fri Dec 16 09:09:48 2022 -0800

    Update bug-report.yml

commit 0472dfe
Author: tooomm <tooomm@users.noreply.github.com>
Date:   Sun Dec 11 19:12:58 2022 +0100

    Docs: Fix leftover issues from conversion (#2172)

commit 8b36c9a
Author: tooomm <tooomm@users.noreply.github.com>
Date:   Sun Dec 11 16:07:08 2022 +0100

    more fixes and cleanup

commit 1266f2d
Author: tooomm <tooomm@users.noreply.github.com>
Date:   Sun Dec 11 12:06:15 2022 +0100

    fix links

commit 8196051
Merge: 06a6eb0 d198142
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Fri Dec 9 16:12:20 2022 -0800

    Merge pull request #2157 from Weltraumschaf/patch-1

    Update setup.md

commit d198142
Author: Sven Strittmatter <ich@weltraumschaf.de>
Date:   Fri Dec 9 22:09:06 2022 +0100

    Update setup.md

    W/o the slash it resolves to /setup/configuration/ which does 404.

commit 06a6eb0
Author: Michael Shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Fri Dec 9 08:15:03 2022 -0800

    fix code block indentation

commit 28819d6
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Fri Dec 9 08:11:42 2022 -0800

    Fix code block indentation

commit 8cd5e25
Merge: 32d5467 7788d93
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Tue Dec 6 11:23:15 2022 -0800

    Merge pull request #2137 from paperless-ngx/more-docs-cleanup

    Chore: Cleanup of new documentation

commit 7788d93
Author: Trenton Holmes <797416+stumpylog@users.noreply.github.com>
Date:   Sun Dec 4 08:34:49 2022 -0800

    Further cleanup of docs, including fixing autoconvert issues and general cleanups

commit 32d5467
Merge: b0ca57a 24da3e5
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Sun Dec 4 19:12:27 2022 -0800

    Merge pull request #2118 from alexander-bauer/chart-bump

commit 24da3e5
Author: Alexander Bauer <sasha@linux.com>
Date:   Mon Dec 5 02:51:35 2022 +0000

    Bump Helm Chart version to trigger release

commit b0ca57a
Merge: cdd49c5 c864b3c
Author: shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Sun Dec 4 14:36:00 2022 -0800

    Merge pull request #2114 from paperless-ngx/v1.10.2-changelog

    [Documentation] Add v1.10.2 changelog

commit cdd49c5
Author: Michael Shamoon <4887959+shamoon@users.noreply.github.com>
Date:   Sun Dec 4 14:32:08 2022 -0800

    Update frontend compilation info

commit c864b3c
Author: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date:   Sun Dec 4 21:17:16 2022 +0000

    Changelog v1.10.2 - GHA
@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shamoon shamoon shamoon requested changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation small-change
Projects
Paperless-ngx
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tooomm @shamoon