Deploying LuxCoreRender

CodeHD — Tue, 05 May 2026 20:31:11 GMT

Documentation and Announcements

← Older revision		Revision as of 22:31, 5 May 2026
(One intermediate revision by the same user not shown)
Line 159:		Line 159:

	== Documentation and Announcements ==		== Documentation and Announcements ==
	~~'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''~~

	Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.		Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
	Furthermore, the final step after release and deployment is to announce the release to the ~~communicate~~.		Furthermore, the final step after release and deployment is to announce the release to the community.

	The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:		The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
	* This wiki		* This wiki, particularly
	** ~~particularly~~ the ~~pages linked on the front page~~		** Release notes
			** FAQ entries
			** Updates to the build process
			** Description of new features, API and SDL documentation
	* The project website		* The project website
	** particularly the downloads section		** particularly the downloads section
Line 174:		Line 176:
	* Announcement on the forums		* Announcement on the forums
	* Announcement in the discord channel		* Announcement in the discord channel
	* Announcement on Blenderartist		* Announcement on Blenderartist, ...

	During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.		During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

	==== Alpha ====		==== Alpha ====
			* Update the release notes
			* Update the API/SDL description
			* Check the authors file and credits list
			* Brief GitHub release notes with warning labels about stability
			* Announcement on the most active user channels
			* Decide on final tasks/known bugs that shall be fixed during alpha/beta phase

	==== Beta ====		==== Beta ====
			* Keep updating release notes and API/SDL documentation
			* Update the Readme files in the code base
			* Start preparing a summary release notes for the GitHub release
			* Announcement of beta phase on more community channels
			* Complete all tasks for features/known bugfixes

	==== Release Candidate ====		==== Release Candidate ====
			* All documentation shall be updated fully
			* Update FAQs with feedback from alpha/beta phase
			* Double check authors and credits
			* GitHub release notes still should contain a warning label
			* Start preparing stable release announcement messages for all channels

	==== Stable (X.Y.0) ====		==== Stable (X.Y.0) ====
	~~At this point~~, ~~all~~		* Double-check all documentation
			* Prepare the final release notes summary
			* Create the release
			* Update the download section on the website
			* Create the announcement post on the forums
			* Finally, announce on Discord and optionally other sites

	==== Bugfix (X.Y.Z) ====		==== Bugfix (X.Y.Z) ====
Line 192:		Line 215:
	* Prepare a summary release notes targeted at users		* Prepare a summary release notes targeted at users
	** This needs to only include the incremental changes from the previous version		** This needs to only include the incremental changes from the previous version
	* Make a short announcement on the same channels as the ~~Stable~~ release		* Make a short announcement on the same channels as the for the stable release

LuxCoreRender Wiki - Recent changes [en]

Deploying LuxCoreRender