feat(docussaurus): upgrade Docussaurus and document development procedures #11
Conversation
lucaaamaral
changed the title
Changing the docusaurus version from costum to the standart open source release Signed-off-by: conradogobato <[email protected]>
…updating dependencies and configurations Signed-off-by: Gabryel Nóbrega <[email protected]>
…mepage layout and styles Signed-off-by: Gabryel Nóbrega <[email protected]>
Signed-off-by: Gabryel Nóbrega <[email protected]>
Remove CHANGELOG and NOTES files, clean up Dockerfile and docker-compose, and update docusaurus configuration Signed-off-by: Gabryel Nóbrega <[email protected]>
lucaaamaral
force-pushed
the
chore/evaluate-conrado-pr
branch
from
670f346 to
5635f10
Compare
|
Commenting just another task to be done in this PR: need to check the new configuration of docusaurus for the "current" version docs (probably |
docusaurus/docusaurus.config.js
Outdated
| // Please change this to your repo. | ||
| // Remove this to remove the "edit this page" links. | ||
| editUrl: | ||
| 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', |
There was a problem hiding this comment.
Could we have this 'edit this page' pointing to this repository?
|
Let's bring CI here to be able to merge. I saw you have them done already. |
* chore: enhance CI workflows with new scripts for documentation checks and remove obsolete reference check Signed-off-by: Gabryel Nóbrega <[email protected]> * chore: update documentation CI workflow for improved checks and formatting Signed-off-by: Gabryel Nóbrega <[email protected]> * debug: Run everything for testing Signed-off-by: Gabryel Nóbrega <[email protected]> * testing: path filter step dependency removal Signed-off-by: Gabryel Nóbrega <[email protected]> * fix: grant execute permissions to workflow scripts for consistency checks Signed-off-by: Gabryel Nóbrega <[email protected]> * fix: update workflow scripts for improved debugging and path handling Signed-off-by: Gabryel Nóbrega <[email protected]> * fix: Convert format to standad POSIX and streamline with dos2unix dependency and consolidating permission grants Signed-off-by: Gabryel Nóbrega <[email protected]> * fix: Update workflow scripts to change directory for dependency installation and improve script execution consistency Signed-off-by: Gabryel Nóbrega <[email protected]> --------- Signed-off-by: Gabryel Nóbrega <[email protected]>
Done |
| cd docusaurus/docs | ||
| MODIFIED_DOCS=$(find . -type f \( -name "*.md" -o -name "*.mdx" \) ! -path "versioned_docs/*") | ||
| else | ||
| BASE_REF="${GITHUB_BASE_REF:-origin/main}" |
There was a problem hiding this comment.
Set the variables that may be changed based on input at the beginning of the script so it is easy to spot and understand.
There was a problem hiding this comment.
to use the extensions in an array need to construct the -name conditions dynamically, ill try to address to that
There was a problem hiding this comment.
Defined as global states (for now) is your proposition to define the vars in the jobs ENV and insert them in the script via the args?
| CHECKED_FILES=$((CHECKED_FILES + 1)) | ||
|
|
||
| filename=$(basename "$file") | ||
| expected_id=$(echo "$filename" | sed 's/\.[^.]*$//') # Remove extension |
There was a problem hiding this comment.
You can use that to remove the extention: expected_id=$(basename "$file" .txt)
https://stackoverflow.com/questions/3362920/get-just-the-filename-from-a-path-in-a-bash-script
There was a problem hiding this comment.
Is possible to add the regex in the basename command?
…cripts Signed-off-by: Gabryel Nóbrega <[email protected]>
Signed-off-by: Gabryel Nóbrega <[email protected]>
Changes Summary
This PR refers to #9.
The first commit was a cherry-pick from the same commit (03377f6) made by Conrado. The other changes are listed below.
Removed
docusaurus/blog/as discussed in Slack, and as the existing text is not relevant to the project, it has been removed.docusaurus/README.mdas it is already present information duplicated with another files likedocs/howtos/documentation_development.md.docusaurus/package-lock.jsonas the local development should be done withyarn.HomepageFeaturescomponents as was only being imported and not used.Added
docusaurus/docs/howtos/documentation_development.mdas to give instructions on how to develop documentation.docusaurus/docker.package.jsonto include the dependencies needed to build the containers.Updated
docusaurus/.dockerignorerefenrencing the the other JS modules that are not needed when building the container.docusaurus/package.jsonto include the latest versions of the dependencies.docusaurus/Dockerfilethe the new instructions to build the containers of Development and Production.index.jsto include the new components and remove the unused ones.Test Plan
Basic Docusaurus build tests
Additional Information
Security Considerations
Meeting scheduled to 27/03/2025.