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

chore: Remove and replace all references to Xenko in the documentation #219

Closed
7 tasks done
Jklawreszuk opened this issue Dec 12, 2023 · 24 comments
Closed
7 tasks done
Assignees
Labels
content Docs content good first issue Good for newcomers help wanted Extra attention is needed manual Related to manual documentation p3 Medium priority, and does not prevent the core functionality

Comments

@Jklawreszuk
Copy link
Contributor

Jklawreszuk commented Dec 12, 2023

The mention of Xenko may be confusing for new users and should be replaced with the current engine name.
I'm creating this issue for tracking 😃

Vaclav: There is lots of Xenko. The easy solution is just to replace the images with the current ones. Please make them .webp.

@Jklawreszuk Jklawreszuk changed the title Remove all references to Xenko in the documentation Remove and replace all references to Xenko in the documentation Dec 12, 2023
@VaclavElias VaclavElias added help wanted Extra attention is needed good first issue Good for newcomers p4 Low priority, nice to have content Docs content manual Related to manual documentation p3 Medium priority, and does not prevent the core functionality and removed p4 Low priority, nice to have labels Jan 3, 2024
@ElvinPero
Copy link

@VaclavElias I can work on this issue. Can you tell what to replace Xenko with?

@VaclavElias
Copy link
Contributor

Hi @ElvinPero. Thank you. I believe, @Jklawreszuk is referring to these 2 pages at least? Am I right?

There is lots of Xenko. The easy solution is just to replace the images with the current ones. Please make them .webp.

More time conusiming would be to actually to review the processes and add any missing text content and screenshots but that can be actually a separate issue.

https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html
https://doc.stride3d.net/latest/en/manual/stride-launcher/index.html

Do you want me to assing this issue to you?

@ElvinPero
Copy link

@VaclavElias Kindly assign this to me and thanks for the explanation.

@VaclavElias
Copy link
Contributor

I upadated the original description with a Task list.

@ElvinPero
Copy link

@VaclavElias I installed and followed steps in the old documentation but some things are removed like agreement policy in the installer no longer shows during installation. Should I remove the steps that are no longer needed in the recent version? Also can I make PR for the first 2 pages first and handle next 4 in a separate PR?

@VaclavElias
Copy link
Contributor

Yes, please, you can remove the steps that are no longer needed. We can always update the docs if something is missed.

Regarding the PRs, your call in this case, because these are safe updates so it doesn't matter if it is just one PR or multiple, whatever works for you 😁.

Thank you.

@VaclavElias
Copy link
Contributor

Hi @ElvinPero, do you have any update for us?

@ElvinPero ElvinPero removed their assignment Feb 8, 2024
@ElvinPero
Copy link

Hello @VaclavElias sorry for the delayed response, due to external workload I was not able to work on the issue. Kindly assign it to someone else.

@parhamgholami
Copy link

If this isn't an urgent task, I could take this on over the next two-ish weeks while I'm waiting for feedback to come in for the blog post.

@VaclavElias
Copy link
Contributor

No problem @ElvinPero, circumstanes are changing for all of us. I made new screenshots like a year ago for this issue and didn't come back to it 🤣. I am reassigning this to @parhamgholami. Thanks @parhamgholami.

I have updated the issue with the pages we are aware need new screenshots, maybe updated/improved content if needed optionally.

Also something related, which can be sorted after. I will create Issue for this in Stride repo as it needs to be fixed there
stride3d/stride#660
https://discord.com/channels/500285081265635328/727168636770582581/1150170088637468846
https://discord.com/channels/500285081265635328/740163288746426368/1010985661702078484

@parhamgholami
Copy link

Sounds good! I'll post updates when I get started. 😄

@Kryptos-FR
Copy link
Member

@parhamgholami I can take the first one (https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html), if you like. I already started collecting the screenshots.

@parhamgholami
Copy link

@parhamgholami I can take the first one (https://doc.stride3d.net/latest/en/manual/get-started/install-stride.html), if you like. I already started collecting the screenshots.

Sounds good!

@VaclavElias
Copy link
Contributor

I have ticked the first box so install-stride.md is done.

@Kryptos-FR
Copy link
Member

Adding https://doc.stride3d.net/latest/en/manual/troubleshooting/stride-doesnt-run.html to the list, since it is referenced by the Getting Started page.

@parhamgholami
Copy link

Just wanted to give an update: I haven't started on this yet. Now that I finished the blog post, I'll be focusing on this next. Should be starting as soon as tomorrow or Sunday.

@minktusk
Copy link
Contributor

Can i be assign?

I have already update some screenshots on the Get started!

However, i din't update yet screenshots in the Assets and Scenes tabs!

2024-08-24.01-02-37.mp4

@VaclavElias
Copy link
Contributor

@parhamgholami, I will be assigning also @minktusk. I hope it is ok :)

@VaclavElias
Copy link
Contributor

@minktusk, yes please.

@VaclavElias
Copy link
Contributor

@minktusk, do you have any update for us? 🙂

@VaclavElias
Copy link
Contributor

@minktusk, I think we can close this. If there are other pages which you mentioned, we shall open a new issue. What do you think?

@VaclavElias VaclavElias changed the title Remove and replace all references to Xenko in the documentation chore: Remove and replace all references to Xenko in the documentation Nov 9, 2024
@minktusk
Copy link
Contributor

minktusk commented Nov 9, 2024

@minktusk, I think we can close this. If there are other pages which you mentioned, we shall open a new issue. What do you think?

Sure!

@VaclavElias
Copy link
Contributor

This issue is now resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Docs content good first issue Good for newcomers help wanted Extra attention is needed manual Related to manual documentation p3 Medium priority, and does not prevent the core functionality
Projects
None yet
Development

No branches or pull requests

6 participants