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

Rename files, internal links, external links. Still incomplete but should cover 98% of docs. #5

Closed
wants to merge 2 commits into from

Conversation

adikhoff
Copy link
Collaborator

@adikhoff adikhoff commented Oct 4, 2024

PLEASE NOTE THIS IS A WORK IN PROGRESS

Main change is migrate.py.

  • Creates a directory _migrated where the converted files go.
  • Automatically searches, replaces strings in all rst files. Then copies them to _migrated
  • Copies static assets that were manually edited to _migrated.
  • For local builds, use sphinx-build -b html ./_migrated/ _build/html
  • Github workflows edited to support the new setup

In the future, the goal is to replace the original rst files with the converted ones, making migrate.py irrelevant.

Copy link

@Nicholai-Korea Nicholai-Korea left a comment

Choose a reason for hiding this comment

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

Reviewed most of the file changes. Final approval waiting on Lead devs.

Copy link

@Salvakiya Salvakiya left a comment

Choose a reason for hiding this comment

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

Good work! We need to squash these commits though. some of the messages are not very descriptive.

@Salvakiya Salvakiya requested a review from Bioblaze October 5, 2024 04:24
@adikhoff
Copy link
Collaborator Author

adikhoff commented Oct 5, 2024

Good work! We need to squash these commits though. some of the messages are not very descriptive.

Yes I'll need to work on that. I've been developing solo lately so not very disciplined when it comes to commit messages. I will squash when I complete the PR.

@tindrew
Copy link
Collaborator

tindrew commented Oct 7, 2024

I'm going to review this, and then when you're back online ping me so we can get together and decide the path forward.

@adikhoff adikhoff force-pushed the master branch 2 times, most recently from fce93cb to ad94f64 Compare October 10, 2024 06:46
- Add Python script that intelligently changes filenames and contents.
  - Makes exceptions for different variations of capitalizations and hyphenation (like
    godot-engine, godotengine, Godot, GODOT, etc.)
  - Distinguishes between names that can be changed immediately versus names that need to
    change later, like subdomains that don't exist yet.
  - The goal was to eliminate every mention of Godot. However since we are aiming to stay
    compatible with Godot, at least some of the unimplemented names will remain so.
  - Removed some content that could only apply to Godot (like mentions of Godot foundation)

- Change ci/cd pipeline scripts (in ./.github) to include the name change in the build
  - Tested successfully on forked repo
  - Also change contribution and PR hints

- Change README.md to reflect the changes
  - Also add short remark on how to generate the name change locally
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