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

Docker Documentation #1251

Merged
merged 31 commits into from
Jan 15, 2024
Merged

Docker Documentation #1251

merged 31 commits into from
Jan 15, 2024

Conversation

r3d91ll
Copy link
Contributor

@r3d91ll r3d91ll commented Jan 14, 2024

Hey All,

I have updated the Docker instructions for the website. The following website documents have been updated:
Installation.md - changes here focus how to use the the Dockerfile.base and Dockerfile.full
Contribute.md - This section focuses on how to use Dockerfile.dev to contribute to the project.

Additionally, changes were made to the Dockerfile.base, Dockerfile.full, and Dockerfile.dev files in autogen/samples/docker/ and I also created a Dockerfiles.md, which discusses how to use it for Development and how to adjust the Dockerfile to fit particular Dev environments.

Why are these changes needed?

  • Previous iterations of the Dockerfiles created environments that dropped the user into root. Developing as the root user should not be encouraged and can present security risks to applications built in such an environment. An autogen user is now created and given sudo access should root access be required.
  • Additionally, I removed the virtual environment inside of docker as it is not needed.
  • Added the installation of Vim nano and curl in the Dockerfile.dev for quality of life at the Docker CLI
  • I added a commented block for the user to add environmental variables to their docker containers; this is useful for access keys and such.

Related issue number

#1103 #1147 #1111

Checks

@r3d91ll
Copy link
Contributor Author

r3d91ll commented Jan 14, 2024

@microsoft-github-policy-service agree

website/sidebars.js Outdated Show resolved Hide resolved
website/docs/Installation.md Outdated Show resolved Hide resolved
@r3d91ll
Copy link
Contributor Author

r3d91ll commented Jan 14, 2024

Hey all,

Ill close and re-submit with that edit removed. my apologies

@r3d91ll r3d91ll closed this Jan 14, 2024
@r3d91ll
Copy link
Contributor Author

r3d91ll commented Jan 14, 2024

closing to address issues with websites/sidebars.js

removed un-related change from website/sidebars.js
@r3d91ll r3d91ll reopened this Jan 14, 2024
@r3d91ll
Copy link
Contributor Author

r3d91ll commented Jan 14, 2024

sorry about that, I have fixed the issues with the website/sidebards.js file.

@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e6325a4) 32.11% compared to head (296d5a3) 32.11%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1251   +/-   ##
=======================================
  Coverage   32.11%   32.11%           
=======================================
  Files          32       32           
  Lines        4391     4391           
  Branches     1024     1024           
=======================================
  Hits         1410     1410           
  Misses       2865     2865           
  Partials      116      116           
Flag Coverage Δ
unittests 32.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qingyun-wu
Copy link
Contributor

Could you fix the conflicts? Thank you!

Todd W Bucy and others added 4 commits January 14, 2024 14:39
added the missing sections back. However, do we still want the docker section under the Optional Dependencies? That looks like it would go better in the Dockerfiles.md file.
Added mount your code back and added mount your directory for better clarity.
Copy link
Contributor Author

@r3d91ll r3d91ll left a comment

Choose a reason for hiding this comment

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

I think I cleaned up all the line and all accidental deletions have been put back in place.

Copy link
Contributor

@qingyun-wu qingyun-wu left a comment

Choose a reason for hiding this comment

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

LGTM. Nice documentation! Thanks!

@sonichi sonichi added this pull request to the merge queue Jan 15, 2024
Merged via the queue into microsoft:main with commit 135bca4 Jan 15, 2024
16 checks passed
Copy link
Collaborator

@maxim-saplin maxim-saplin left a comment

Choose a reason for hiding this comment

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

Looks good!

joshkyh pushed a commit that referenced this pull request Jan 17, 2024
* Updates to the Dockerfiles making them more secure. update to the installation.md file and a start.sh file for the Dockerfile.dev to start the document server. Not ready for pull request.

* updates to the docker documentation

* clean up before commit

* added docker instructions on how to test  documentation prior to commit.

* fixed the title heading in the installation.md

* removed alternate yarn install from Dockerfile.dev

* Update sidebars.js

removed un-related change from website/sidebars.js

* cleaned up the lint errors from the pre-commit-check.

* removed bad edit from sidebars.js

* fixing git conflict with sidebars.js file

* Update Installation.md

added the missing sections back. However, do we still want the docker section under the Optional Dependencies? That looks like it would go better in the Dockerfiles.md file.

* Update Installation.md

Added mount your code back and added mount your directory for better clarity.

* Update Installation.md

Lint cleanup

* Update Installation.md

removed the relative path to samples/dockers/Dockerfiles.md with a proper URL to where it will exist

* fixed bad link to Dockerfiles.md

* Fix trailing whitespace and formatting issues

* Update link to Dockerfiles.md

* somtimes its really hard to find that lost i.

* trailing whitespace and EOF issues resolved

* fixed broken link

* trailing space an broken link

* removed broken links. will update one merged.

* fixed glaring error about building an image from a particular branch Contribute.md

* removed tic mark typo from contribute.md

---------

Co-authored-by: Todd W Bucy <todd.bucy@rackspace>
@r3d91ll r3d91ll mentioned this pull request Jan 18, 2024
1 task
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* Updates to the Dockerfiles making them more secure. update to the installation.md file and a start.sh file for the Dockerfile.dev to start the document server. Not ready for pull request.

* updates to the docker documentation

* clean up before commit

* added docker instructions on how to test  documentation prior to commit.

* fixed the title heading in the installation.md

* removed alternate yarn install from Dockerfile.dev

* Update sidebars.js

removed un-related change from website/sidebars.js

* cleaned up the lint errors from the pre-commit-check.

* removed bad edit from sidebars.js

* fixing git conflict with sidebars.js file

* Update Installation.md

added the missing sections back. However, do we still want the docker section under the Optional Dependencies? That looks like it would go better in the Dockerfiles.md file.

* Update Installation.md

Added mount your code back and added mount your directory for better clarity.

* Update Installation.md

Lint cleanup

* Update Installation.md

removed the relative path to samples/dockers/Dockerfiles.md with a proper URL to where it will exist

* fixed bad link to Dockerfiles.md

* Fix trailing whitespace and formatting issues

* Update link to Dockerfiles.md

* somtimes its really hard to find that lost i.

* trailing whitespace and EOF issues resolved

* fixed broken link

* trailing space an broken link

* removed broken links. will update one merged.

* fixed glaring error about building an image from a particular branch Contribute.md

* removed tic mark typo from contribute.md

---------

Co-authored-by: Todd W Bucy <todd.bucy@rackspace>
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.

5 participants