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

Fix links in markup docs #151

Merged
merged 1 commit into from
Aug 7, 2023
Merged

Fix links in markup docs #151

merged 1 commit into from
Aug 7, 2023

Conversation

WebVPF
Copy link
Contributor

@WebVPF WebVPF commented Aug 7, 2023

@LukeTowers LukeTowers merged commit 8684195 into wintercms:develop Aug 7, 2023
1 check passed
@arvislacis
Copy link
Contributor

Should be merged also in 1.2 branch for changes to be reflected on Docs website.

@LukeTowers
Copy link
Member

Changes are reflected in the docs website when we clear the cache; we need to add that as a step to the webhook processing.

@WebVPF
Copy link
Contributor Author

WebVPF commented Aug 17, 2023

@LukeTowers please clear the cache

@LukeTowers
Copy link
Member

Done @WebVPF

@WebVPF
Copy link
Contributor Author

WebVPF commented Aug 18, 2023

@LukeTowers
Fixes from this pull request did not apply.
Here is the first link https://wintercms.com/docs/v1.2/markup/this/page
Should be like this: ../../docs/cms/pages#page-variables

It turns out that the pull request was made in the wrong branch.

@LukeTowers
Copy link
Member

@WebVPF thanks, I merged it into the correct branch but the site is waiting on a PR to allow for both branches to play nicely together. At the moment I'm just having trouble with the UI for switching between branches of the documentation, perhaps you could have a look and let me know your thoughts?

image

image

I don't like how duplicated it looks and feel like there's a better way to handle selecting from a different version of the docs, but don't have time to mock up an example at the moment. Do you think you could take a stab at it or provide some input?

@LukeTowers
Copy link
Member

Ideally the release flow will be that the main docs on the website will be the dev branch (so the master branch like on Laravel) and then if people want to switch to a different version they can; with the docs release cycle following the same as the main code itself (when a new version is released dev is merged into the current main branch for the main winter repo as well as now the docs repo).

@LukeTowers
Copy link
Member

Note that I'd like to be able to provide each of the main branches (currently 1.1, 1.2, and dev, but very soon 1.3, 1.4, etc)

@WebVPF
Copy link
Contributor Author

WebVPF commented Aug 18, 2023

@LukeTowers
Version selection through the select element:

1

2

3

@LukeTowers
Copy link
Member

@bennothommo does that work for you?

@bennothommo
Copy link
Member

bennothommo commented Aug 21, 2023

@LukeTowers @WebVPF I suppose that will work, but will need to find a new home for the theme switcher (dark/light).

To be honest, I also want to remove the landing page altogether - it's an unnecessary extra click to get to where you want. It's only in the Nabu theme as an example.

@WebVPF
Copy link
Contributor Author

WebVPF commented Aug 21, 2023

@bennothommo

4

@bennothommo
Copy link
Member

@WebVPF I went this way, implementing your ideas:

261953405-17090212-33a5-4e5f-b56d-fd7da796c749.png

@WebVPF
Copy link
Contributor Author

WebVPF commented Aug 28, 2023

@LukeTowers Will the fixes from this Pull Request ever work in the documentation on the site?

@LukeTowers
Copy link
Member

@WebVPF yes, we have pending changes to the main website docs, just waiting for us to finish testing / merge it in. Check back in with me in a week if I haven't dealt with it by then.

@WebVPF
Copy link
Contributor Author

WebVPF commented Dec 28, 2023

@LukeTowers will this PR be included in the documentation?

@LukeTowers
Copy link
Member

@bennothommo I can't remember at the moment, was there anything special we needed to do to trigger the docs to update on the main website? I know we still have to merge the multi-branch support PR but this should have been deployed automatically when I merged the 1.2.4 docs pr into the 1.2 branch AFAIK.

@bennothommo
Copy link
Member

@LukeTowers I think we have them hooked up to webhooks, but there is a URL you can go to direct to refresh the docs. I can send to you if needed :)

@LukeTowers
Copy link
Member

@bennothommo please do :)

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.

4 participants