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: update #4349

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

DOCs: update #4349

wants to merge 9 commits into from

Conversation

sreichel
Copy link
Contributor

@sreichel sreichel commented Nov 12, 2024

@colinmollenhour i think we can point docs to https://OpenMage.github.io/magento-lts/.

(instead of forwarding to openmage.org)

@colinmollenhour
Copy link
Member

I tried everything I could find to get rid of the redirect... Not sure why I couldn't, but I was able to get the site published to https://docs.openmage.org/
Note that I had to switch the publish mode to Classic Pages to get it to work and Github created the commit 7806f0e for me automatically. Do you see any issue with this file being here?

image

README.md Outdated Show resolved Hide resolved
sreichel and others added 2 commits November 14, 2024 18:37
Co-authored-by: Colin Mollenhour <[email protected]>
@sreichel
Copy link
Contributor Author

Added some content from https://github.com/OpenMage/documentation ... (just to have it here).

@colinmollenhour i think the RTD page should be closed (possibly forwarded) to not have outdated content out there. Archive repo?

@colinmollenhour
Copy link
Member

Yes, I agree that site should be folded into the new docs site. I think the docs being in the same repo will be a big improvement because the issues and PRs will be all in one place. For example, I wasn't even aware of OpenMage/documentation#12.. Also when a BC change is made we can require the docs to be updated in the same PR.

@colinmollenhour
Copy link
Member

I updated the README and index page and archived the old docs repo.

@sreichel
Copy link
Contributor Author

Thanks.

Having docs here should be more contributor-friendly.

Ping @m-michalis Want to update OpenMage/documentation#12?

@m-michalis
Copy link

Ping @m-michalis Want to update OpenMage/documentation#12?

In the end, I never did implement K8s cluster with OpenMage. I played with it but that's it. If you see any value over my PR, you are free to do as you please.

@sreichel
Copy link
Contributor Author

@colinmollenhour
Copy link
Member

@sreichel I'm not sure we can fix that, I think it is a redirect problem because the path "/magento-lts/" matches the repo name and GitHub pages is treating it as a request to the magento-lts repo site rather than the OpenMage/OpenMage.github.io repo.. I think the best solution is to relocate these pages to a different subdirectory.

@sreichel
Copy link
Contributor Author

Thats (nearly fixed).

Update

  • fixed syntax in API section
  • add blog with all releases and a few guides (1)
  • minor fixes/improvements

Note 1:

About having blog posts here ...

  • CONs

    • <100kb "more"
    • no multilang support atm, mkdocs can, but is it worth?
  • PROs

    • no other repo, easier to update
    • context is searchhable, current blog is not

@colinmollenhour
Copy link
Member

I think my preference is to keep blog posts in the main site so that writing and publishing them can follow a different process than code and documentation changes. Docs make sense, but blog posts could be random thoughts, announcements, etc.. I don't think we want that in our code repo so it's more about separation of concerns for me.

@sreichel
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants