Fixed CI configuration: adapted folder structure

[Dscano]

Moved the folder from docs/v1/build to docs/v1 and separately copied the generated files.
@chrispsommers

[jafingerhut]

LGTM

[chrispsommers]

@jafingerhut @Dscano The build finally went through, until it encountered upload auth issues. Does anybody know the solution?

[Dscano]

@jafingerhut @Dscano The build finally went through, until it encountered upload auth issues. Does anybody know the solution?

I compared the logs from main-branch-uploads-success and main-branch-uploads-fails. It seems that in the main-branch-uploads-fails run, the deletion of old files is performed, but we are unable to do this due to permission issues. These permissions are related to the AWS_S3 user that runs the command.

Based on the arguments and this guide, It should be fine, but further investigation is needed.

[jafingerhut]

I don't know the solution, but perhaps this CI task does not have access to the secret credentials required to update that S3 storage account?

[chrispsommers]

@antoninbas Any ideas here? Thanks.

[chrispsommers]

@fruffy we're having S3 access issues, do you have any advice?

[antoninbas]

I have added the missing permission so it should work now.

Also, please modify the job definition so that only the required files are uploaded (build outputs), not all the source files. cc @Dscano

On a side note, this is my personal AWS account. I am happy to keep it going the way it is, but feel free to switch to a p4.org account if such a thing exists.

Finally, it seems that the build outputs are no longer "copied" to the gh-pages branch, which means the official p4.org links are no longer up-to-date.

[fruffy]

Can check this over the weekend if it isn't resolved by then.

[chrispsommers]

Thanks @antoninbas. @fruffy we should probably have p4.org account for this and not depend upon personal accounts, although Antonin has graciously extended his use of his.

[chrispsommers]

@Dscano Could you please take a look at @antoninbas's comments? Thanks!

[Dscano]

Hi @chrispsommers, I’ve addressed Antoinnin’s comment in this PR #541 (comment)

[fruffy]

@AdarshRawat1 You did a great job with automated documentation and CI for P4C. We have similar problem here with P4Runtime. Do you think you could set up a similar structure for p4runtime? We do not need Doxygen etc, html and pdf previews for a branch are enough. If you are interested we can discuss with @chrispsommers, @Dscano, and @jafingerhut. I do not think it will be a big time investment.

@antoninbas Trying to understand the current setup. Why do we need AWS, to upload the html and PDF files. Is github pages not enough?

[AdarshRawat1]

@AdarshRawat1 You did a great job with automated documentation and CI for P4C. We have similar problem here with P4Runtime. Do you think you could set up a similar structure for p4runtime?

I'll be happy to help! I'm looking into the current setup and will update you soon.

@antoninbas Trying to understand the current setup. Why do we need AWS, to upload the html and PDF files. Is github pages not enough?

+1 on this.

[AdarshRawat1]

Finally, it seems that the build outputs are no longer "copied" to the gh-pages branch, which means the official p4.org links are no longer up-to-date.

@antoninbas Could you help me understand why the latest GitHub Pages deployment is pointing to this?

Even the June 7, 2024 deployment leads to an empty page. Has it been like this from the start, or did something change recently?

[AdarshRawat1]

Do you think you could set up a similar structure for p4runtime? We do not need Doxygen etc, html and pdf previews for a branch are enough.

Based on the docs, I'm assuming that we'll be working with AsciiDoc for rendering the output on GitHub Pages. Is this what you have in mind?

[fruffy]

Do you think you could set up a similar structure for p4runtime? We do not need Doxygen etc, html and pdf previews for a branch are enough.

Based on the docs, I'm assuming that we'll be working with AsciiDoc for rendering the output on GitHub Pages. Is this what you have in mind?

Davide set this up in #510. Afaik this is already working but I have not kept up with the developments in this repository.

[Dscano]

Do you think you could set up a similar structure for p4runtime? We do not need Doxygen etc, html and pdf previews for a branch are enough.

Based on the docs, I'm assuming that we'll be working with AsciiDoc for rendering the output on GitHub Pages. Is this what you have in mind?

Yes, so basically, AsciiDoc is the text processor used to generate the .pdf and .html files. You can generate these files via the make command within the p4runtime/docs/v1/.