docs: various improvements #1467

dpschen · 2023-04-03T09:56:05Z

dpschen commented

2023-04-03 09:56:05 +00:00

removing spaces at end of line
fixing spelling and grammar mistakes
making sure 'Vikunja' is spelled the same way everywhere
prefer using editors word wrap instead of hardcoding word wrap in markdown (reason: different word wrap per editor & end of line space)
add newline add end where missing
remove double colon at end of headlines
remove unnecessary indention
make sure code blocks and headlines etc always have an empty line around

- removing spaces at end of line - fixing spelling and grammar mistakes - making sure 'Vikunja' is spelled the same way everywhere - prefer using editors word wrap instead of hardcoding word wrap in markdown (reason: different word wrap per editor & end of line space) - add newline add end where missing - remove double colon at end of headlines - remove unnecessary indention - make sure code blocks and headlines etc always have an empty line around

konrad reviewed 2023-04-03 10:03:34 +00:00

docs/content/doc/setup/build-from-source.md Outdated

						
				@ -28,2 +27,3 @@

				*Note:* Static resources such as email templates are built into the binary.

				For these to work, you may need to run `mage build:generate` before building the vikunja binary.

				When builing entirely with `mage`, you dont need to do this, `mage build:generate` will be run automatically when running `mage build:build`.

				When building entirely with `mage`, you don't need to do this, `mage build:generate` will be run automatically when running `mage build:build`.

konrad commented

2023-04-03 10:03:34 +00:00

This is actually outdated and not required. I'll update on main.

👍 1 ✅ 1

dpschen commented

2023-04-11 10:18:18 +00:00

Rebased

dpschen marked this conversation as resolved

konrad reviewed 2023-04-03 10:05:22 +00:00

docs/content/doc/setup/reverse-proxies.md Outdated

						
				@ -96,2 +97,2 @@

After saving the edited file, return to NPM's UI browser window and refresh the page to verify your Proxy Host for Vikunja is still online. 

Now, switch over to your Vikunja browswer window and hit refresh. If you configured your URL correctly in original Vikunja container, you should be all set and the browser will correctly show Vikunja. If not, you'll need to adjust the address in the top of the login subscreen to match your proxy address.

After saving the edited file, return to NPM's UI browser window and refresh the page to verify your Proxy Host for Vikunja is still online.

konrad commented

2023-04-03 10:05:22 +00:00

Shouldn't this be the 6th point? As it continues from the 5th.

✅ 1

dpschen commented

2023-04-05 11:54:34 +00:00

Oh yes obviously. This was updated by an editor plugin…

👍 1

dpschen commented

2023-04-11 10:21:31 +00:00

Fixed

dpschen marked this conversation as resolved

konrad reviewed 2023-04-03 10:06:33 +00:00

docs/content/doc/setup/config.md

						
				@ -10,8 +10,7 @@ menu:

				# Configuration options

konrad commented

2023-04-03 10:06:33 +00:00

This will be regenerated from the sample config. Please fix the typos there and then regenerate it.

✅ 1

dpschen commented

2023-04-11 10:22:57 +00:00

Done now in vikunja/api#1489

~~Shouldn't we delete this file, remove it from version control and put it in gitignore, so that it will be auto generated like the docs themselves?~~~

EDIT: Understood how the inlining works. Fixed this commit.

Done now in https://kolaente.dev/vikunja/api/pulls/1489 ~~Shouldn't we delete this file, remove it from version control and put it in gitignore, so that it will be auto generated like the docs themselves?~~~ EDIT: Understood how the inlining works. Fixed this commit.

dpschen marked this conversation as resolved

konrad changed title from ~~feat(docs): various improvements~~ to docs: various improvements

2023-04-03 10:08:02 +00:00

dpschen force-pushed improve-docs from 9a70ccd8aa to 9918d92cc0

2023-04-11 10:17:35 +00:00

Compare

dpschen force-pushed improve-docs from 9918d92cc0 to d81f0f3bc3

2023-04-11 10:21:25 +00:00

Compare

konrad was assigned by dpschen

2023-04-11 10:23:10 +00:00

dpschen requested review from konrad 2023-04-11 10:23:14 +00:00

dpschen force-pushed improve-docs from d81f0f3bc3 to d60e898990

2023-04-11 10:29:56 +00:00

Compare

dpschen force-pushed improve-docs from d60e898990 to fea349ab77

2023-04-11 10:44:49 +00:00

Compare

konrad reviewed 2023-04-11 16:31:22 +00:00

konrad left a comment

Please rebase once more when vikunja/api#1489 is merged

Please rebase once more when https://kolaente.dev/vikunja/api/pulls/1489 is merged

🎉 1

konrad force-pushed improve-docs from fea349ab77 to aaa0593289

2023-04-11 16:43:03 +00:00

Compare

konrad approved these changes 2023-04-11 16:43:17 +00:00

konrad scheduled this pull request to auto merge when all checks succeed 2023-04-11 16:43:27 +00:00

konrad merged commit aaa0593289 into main

2023-04-11 17:04:21 +00:00

konrad deleted branch improve-docs

2023-04-11 17:13:10 +00:00

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: vikunja/vikunja#1467

 @ -96,2 +97,2 @@
 . After saving the edited file, return to NPM's UI browser window and refresh the page to verify your Proxy Host for Vikunja is still online.
 . Now, switch over to your Vikunja browswer window and hit refresh. If you configured your URL correctly in original Vikunja container, you should be all set and the browser will correctly show Vikunja. If not, you'll need to adjust the address in the top of the login subscreen to match your proxy address.
 . After saving the edited file, return to NPM's UI browser window and refresh the page to verify your Proxy Host for Vikunja is still online.