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

TOC and file renaming #88

Merged
merged 2 commits into from
Jul 7, 2024

Conversation

root-hal9000
Copy link
Contributor

- renamed all files to be lowercase and have no spaces
- Updated all references to those names in file content
- Recreated table of contents into readme.MD Issue TriliumNext#2
- Separated "importing docs" text into a separate file
- Added a few %%{WARNING}%% tags to links that go to zadams repos. Issue TriliumNext#87
Copy link
Contributor

@Alumniminium Alumniminium left a comment

Choose a reason for hiding this comment

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

Please delete the old files with MixedCase.

@Alumniminium Alumniminium added documentation Improvements or additions to documentation initial-review adds to initial-review project labels Jul 6, 2024
@root-hal9000
Copy link
Contributor Author

Please delete the old files with MixedCase.

Oops, sorry about that, they had been deleted (I originally renamed them with a bash script) but I had issues commiting and re-cloned to copy my changes over and didn't notice that. Will do

@root-hal9000
Copy link
Contributor Author

root-hal9000 commented Jul 6, 2024

OK, deleted the old files - anything else here or should I merge. If someone merges, create a new initial-review branch from main after merging this.

Also, I forgot to note that I did make some slight changes to the order of the TOC as suggested in issue #2 - mostly just moving things for newer users up the TOC in places where order didn't necessarily matter (e.g.: desktop installation before all the different server installation instructions)

@maphew
Copy link
Contributor

maphew commented Jul 7, 2024

was all of this work scripted? I presume yes or mostly. Perhaps put them in /utils or something, or at least keep the transition scripts handy in the event there's more changes upstream. I don't think there's a high probability of that, but have been bitten many times in the past by the thought "we'll only need to do this once" ... ;-)

@root-hal9000
Copy link
Contributor Author

root-hal9000 commented Jul 7, 2024

was all of this work scripted? I presume yes or mostly.

Only the renaming of the files to lowercase/no space (and replacing of the links referring to them). The TOC was manual as there's no inherent structure in the files for that and I made some slight changes to the order. Sorry, it was more clear with separate commits but I wound up having to squash it all

It was a quick and dirty thing, but I can add it

@Alumniminium Alumniminium merged commit f5961ba into TriliumNext:TOC-to-readme Jul 7, 2024
@Alumniminium
Copy link
Contributor

oh god i should have merged that from the terminal and not from the web... what just happened

@root-hal9000
Copy link
Contributor Author

root-hal9000 commented Jul 7, 2024

oh god i should have merged that from the terminal and not from the web... what just happened

Just got out of the meeting, not sure what you're referring to, although I see a couple of new branches?

Also, I should have made the PR to the main branch, no? We should merge this into main, and then pull the initial-review branch from there

@Alumniminium
Copy link
Contributor

Done. I've merged that branch into main and created an 'initial-review' branch from the new main. @root-hal9000

@root-hal9000 root-hal9000 deleted the TOC-to-readme branch July 9, 2024 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation initial-review adds to initial-review project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants