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

Include the news folder in the repo FBO documentation git submodule #5336

Closed
wants to merge 2 commits into from

Conversation

stevepiercy
Copy link
Collaborator

@stevepiercy stevepiercy commented Oct 24, 2023

Before merging, please try to reproduce what I see locally. If you do not see it, then it is my local repo and possibly a symlink issue. This might be related to my work on #5135


For about the last month, when a submodule tip was included in some pull request, the news folder got dropped. Now plone/documentation always says this:

$ git status
On branch 6.0
Your branch is up to date with 'origin/6.0'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
  (commit or discard the untracked or modified content in submodules)
        modified:   submodules/volto (untracked content)

no changes added to commit (use "git add" and/or "git commit -a")

...even after manually going through those steps. So I think that this pull request will fix that. Now I see:

$ git status
On branch 6.0
Your branch is up to date with 'origin/6.0'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   submodules/volto (new commits)

no changes added to commit (use "git add" and/or "git commit -a")

...which is hopeful.

@netlify
Copy link

netlify bot commented Oct 24, 2023

Deploy Preview for volto ready!

Name Link
🔨 Latest commit 5f67c85
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/65380015f8e4d30008fded5d
😎 Deploy Preview https://deploy-preview-5336--volto.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sneridagh
Copy link
Member

@stevepiercy this one after #5135 right?

@stevepiercy
Copy link
Collaborator Author

After building docs locally, if you see that git submodule warning from git status now, then you can merge this PR now. If not, then after merging #5135, and after building docs locally, if you start to see that git submodule warning, then this PR will solve that issue. Basically I am not entirely sure when it started to appear for me locally, so I hoped someone else could try to reproduce it.

@sneridagh
Copy link
Member

@stevepiercy the release (17.4.0) went well, no issues whatsoever, how about documentation? I think all good in there too, right? Can we say that this is not needed?

@stevepiercy
Copy link
Collaborator Author

stevepiercy commented Nov 6, 2023

I think it is needed.

Go into documentation and make clean html. One warning pops up:

/Users/stevepiercy/projects/Plone/documentation/docs/volto/index.md:46: WARNING: toctree contains reference to nonexisting document 'volto/news*'

...and when going into Volto:

 /Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/4947.feature: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/4949.feature: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5294.breaking: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5363.documentation: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5364.bugfix: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5367.internal: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5368.bugfix: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5370.documentation: WARNING: document isn't included in any toctree
/Users/stevepiercy/projects/Plone/documentation/submodules/volto/docs/source/news/5371.documentation: WARNING: document isn't included in any toctree

It appears the problem shifted from the git submodule error to these build errors, at least for me. If you can reproduce these warnings locally, then I would go ahead and merge it. If not, report back what you see, and we can troubleshoot.

@stevepiercy
Copy link
Collaborator Author

This PR is no longer necessary, as the issue has gone away. Closing.

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

Successfully merging this pull request may close these issues.

2 participants